Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feature/mouse #53

Merged
merged 13 commits into from
Apr 4, 2020
Prev Previous commit
Next Next commit
better readthedocs autosummary
  • Loading branch information
marcmaxson committed Mar 11, 2020
commit 2c47ade7b4d8d1492e78cf16c3aa3e457d8219a0
3 changes: 2 additions & 1 deletion conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
24 changes: 24 additions & 0 deletions docs/source/modules.rst
Original file line number Diff line number Diff line change
@@ -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:
1 change: 1 addition & 0 deletions index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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/>
Expand Down
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -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',
Expand Down