better readthedocs autosummary

FoxoTech · Mar 11, 2020 · 2c47ade · 2c47ade
1 parent 9d9d3c8
commit 2c47ade
Show file tree

Hide file tree

Showing 4 changed files with 28 additions and 2 deletions.
diff --git a/conf.py b/conf.py
@@ -42,7 +42,8 @@
     'sphinx.ext.autodoc',
     'sphinxcontrib.apidoc',
     'm2r',
-    'nbsphinx'
+    'nbsphinx',
+    'sphinx.ext.autosummary'
 ]
 
 # instead of CLI "sphinx-autodoc . _build/html" you write this

diff --git a/docs/source/modules.rst b/docs/source/modules.rst
@@ -1,19 +1,43 @@
 Module contents
 ---------------
 
+.. autosummary::
+   methylprep.processing
+   methylprep.run_pipeline
+   methylprep.files.create_sample_sheet
+   methylprep.download
+   methylprep.run_series
+   methylprep.read_geo
+   methylprep.build_composite_dataset
+   methylprep.models
+   methylprep.files
+
+
 .. automodule:: methylprep
     :members:
     :undoc-members:
     :show-inheritance:
 
+processing
+##########
+
 .. automodule:: methylprep.processing
     :members:
 
+models
+######
+
 .. automodule:: methylprep.models
     :members:
 
+files
+#####
+
 .. automodule:: methylprep.files
     :members:
 
+geo download
+############
+
 .. automodule:: methylprep.download
     :members:
diff --git a/index.rst b/index.rst
@@ -18,6 +18,7 @@ Getting Started
 
    docs/methylprep_tutorial.md
    docs/example_download.md
+   docs/faq.md
    docs/README.md
    docs/source/modules
    methylcheck (QC) package <https://life-epigenetics-methylcheck.readthedocs-hosted.com/en/latest/>

diff --git a/setup.py b/setup.py
@@ -3,7 +3,7 @@
 
 setup(
     name='methylprep',
-    version='1.2.4',
+    version='1.2.5',
     description='Python-based Illumina methylation array preprocessing software',
     long_description=open('README.md').read(),
     long_description_content_type='text/markdown',