From b0d5c3b925e8b4c7b20b8335e889c3d57b86c56d Mon Sep 17 00:00:00 2001 From: frehburg Date: Wed, 4 Sep 2024 12:16:32 +0200 Subject: [PATCH 1/4] added author --- docs/conf.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/conf.py b/docs/conf.py index d72cf1ce..ea32b3f3 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -16,7 +16,7 @@ project = 'rarelink_phenopacket_mapper' copyright = '2024, test' -author = 'test' +author = 'Filip Rehburg' release = '0.0.1' # -- General configuration --------------------------------------------------- From 0261ed5034aab7101bcfaa1cf657b6bf92048493 Mon Sep 17 00:00:00 2001 From: frehburg Date: Wed, 4 Sep 2024 12:17:00 +0200 Subject: [PATCH 2/4] updated index.rst to doc all modules and not have redundant doc --- docs/index.rst | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/docs/index.rst b/docs/index.rst index d15aa8db..7ab64d3a 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -3,8 +3,13 @@ You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive. -Welcome to rarelink_phenopacket_mapper's documentation! -================================= + +=========================== +RareLink Phenopacket Mapper +=========================== + +.. automodule:: rarelink_phenopacket_mapper + :members: .. toctree:: :maxdepth: 2 From 12412adc09ee962c9372846eb1fb73b58dfb1984 Mon Sep 17 00:00:00 2001 From: frehburg Date: Wed, 4 Sep 2024 12:17:18 +0200 Subject: [PATCH 3/4] updated doc of package in init file of package, auto displayed in doc --- src/rarelink_phenopacket_mapper/__init__.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/rarelink_phenopacket_mapper/__init__.py b/src/rarelink_phenopacket_mapper/__init__.py index 2205152f..5c30d838 100644 --- a/src/rarelink_phenopacket_mapper/__init__.py +++ b/src/rarelink_phenopacket_mapper/__init__.py @@ -1,4 +1,4 @@ -"""An example description for the rarelink_phenopacket_mapper package.""" +"""A package to map data from the RareLink format in REDCap to the GA4GH Phenopacket schema (v2).""" __version__ = "0.0.1" From 742a065ac96d080f2546d7c7c7cb7f0b49990c10 Mon Sep 17 00:00:00 2001 From: frehburg Date: Wed, 4 Sep 2024 12:19:26 +0200 Subject: [PATCH 4/4] linking to the cli doc --- docs/index.rst | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/index.rst b/docs/index.rst index 7ab64d3a..7e0762c7 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -15,6 +15,7 @@ RareLink Phenopacket Mapper :maxdepth: 2 :caption: Contents: +See the CLI documentation :doc:`here `. Indices and tables