Merge pull request #18 from BIH-CEI/17-improve-docs-on-gh-pages

updated gh pages doc a bit
BIH-CEI · Sep 4, 2024 · c4d420e · c4d420e
2 parents 67e6293 + 742a065
commit c4d420e
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 4 deletions.
diff --git 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 ---------------------------------------------------

diff --git a/docs/index.rst b/docs/index.rst
@@ -3,13 +3,19 @@
    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
    :caption: Contents:
 
+See the CLI documentation :doc:`here <apidocs/rarelink_phenopacket_mapper.cli>`.
 
 
 Indices and tables

diff --git 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"