From 5e6601a873d265289223da4b586b63342f7ec3eb Mon Sep 17 00:00:00 2001 From: Alexander Minges Date: Fri, 25 Jul 2025 09:56:00 +0200 Subject: [PATCH] docs: fix list formatting in docstrings Add proper spacing before lists in docstrings to ensure correct rendering in sphinx API documentation: - Fix package functionality list in __init__.py - Fix environment variable list in config.py This prevents lists from being rendered as run-on text in the generated API reference documentation. --- doi2dataset/__init__.py | 2 ++ doi2dataset/core/config.py | 1 + 2 files changed, 3 insertions(+) diff --git a/doi2dataset/__init__.py b/doi2dataset/__init__.py index 28973a7..b23e9f9 100644 --- a/doi2dataset/__init__.py +++ b/doi2dataset/__init__.py @@ -2,12 +2,14 @@ doi2dataset: A tool to process DOIs and generate metadata for Dataverse datasets. This package provides functionality to: + - Validate and process DOIs - Fetch metadata from external APIs (OpenAlex, CrossRef) - Generate Dataverse-compatible metadata - Upload datasets to Dataverse instances The package is organized into several modules: + - core: Configuration, models, and metadata field definitions - api: API clients and processors - processing: Business logic for citation building and metadata processing diff --git a/doi2dataset/core/config.py b/doi2dataset/core/config.py index 78fdc9d..e76ea0a 100644 --- a/doi2dataset/core/config.py +++ b/doi2dataset/core/config.py @@ -41,6 +41,7 @@ class Config: Singleton class to handle configuration loading and retrieval. Supports environment variable overrides for Dataverse configuration: + - DATAVERSE_URL: Overrides dataverse.url - DATAVERSE_API_TOKEN: Overrides dataverse.api_token - DATAVERSE_DATAVERSE: Overrides dataverse.dataverse