add code

endast · Nov 21, 2023 · 48fbb98 · 48fbb98
1 parent 53dd007
commit 48fbb98
Show file tree

Hide file tree

Showing 4 changed files with 17 additions and 4 deletions.
diff --git a/.readthedocs.yaml b/.readthedocs.yaml
@@ -12,7 +12,7 @@ build:
 
 # Build documentation in the "docs/" directory with Sphinx
 sphinx:
-   configuration: docs/conf.py
+   configuration: docs/source/conf.py
    fail_on_warning: true
 
 formats:

diff --git a/docs/source/api.rst b/docs/source/api.rst
@@ -0,0 +1,16 @@
+API
+===
+
+.. autosummary::
+   :toctree: generated
+
+.. automodule:: fake_vcf
+    :members:
+
+
+.. automodule:: fake_vcf.vcf_faker
+    :members:
+
+
+.. automodule:: fake_vcf.vcf_generator
+    :members:
diff --git a/docs/conf.py → docs/source/conf.py b/docs/conf.py → docs/source/conf.py
diff --git a/docs/index.rst → docs/source/index.rst b/docs/index.rst → docs/source/index.rst
@@ -5,9 +5,6 @@
 
 Welcome to fake-vcf's documentation!
 ====================================
-.. automodule:: fake_vcf
-    :members:
-
 
 .. toctree::
    :maxdepth: 2