diff --git a/docs/requirements.txt b/docs/requirements.txt index d708984..6d897c3 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -14,5 +14,5 @@ statsmodels scipy astropy<6.0 sphinx_markdown_tables -recommonmark +m2r2 sphinx_rtd_theme diff --git a/docs/source/api_group_pipeline.rst b/docs/source/api_group_pipeline.rst new file mode 100644 index 0000000..bf135f6 --- /dev/null +++ b/docs/source/api_group_pipeline.rst @@ -0,0 +1,7 @@ +API - Group Pipeline +==================== + +.. automodule:: wearablehrv.group + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api_individual_pipeline.rst b/docs/source/api_individual_pipeline.rst new file mode 100644 index 0000000..f0530d3 --- /dev/null +++ b/docs/source/api_individual_pipeline.rst @@ -0,0 +1,7 @@ +API - Individual Pipeline +========================= + +.. automodule:: wearablehrv.individual + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/conf.py b/docs/source/conf.py index bfd3e04..d8f6648 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -21,7 +21,7 @@ extensions = [ "sphinx.ext.autodoc", - "recommonmark", + "m2r2", "sphinx_markdown_tables", "sphinx_rtd_theme", ] diff --git a/docs/source/index.rst b/docs/source/index.rst index 86289ec..d57811e 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -3,21 +3,17 @@ You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive. +Welcome to the wearablehrv documentation! +========================================= + .. mdinclude:: ../../README.md .. toctree:: :maxdepth: 2 :caption: Contents: -.. automodule:: wearablehrv.individual - :members: - :undoc-members: - :show-inheritance: - -.. automodule:: wearablehrv.group - :members: - :undoc-members: - :show-inheritance: + api_individual_pipeline + api_group_pipeline Indices and tables ================== @@ -25,3 +21,4 @@ Indices and tables * :ref:`genindex` * :ref:`modindex` * :ref:`search` +