Updates to docs for improved autodoc

JSybrandt · Apr 29, 2020 · 080b0a6 · 080b0a6
1 parent 690415b
commit 080b0a6
Show file tree

Hide file tree

Showing 5 changed files with 31 additions and 9 deletions.
diff --git a/docs/agatha.rst b/docs/agatha.rst
@@ -0,0 +1,10 @@
+agatha package
+==============
+
+Module contents
+---------------
+
+.. automodule:: agatha
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/conf.py b/docs/conf.py
@@ -32,7 +32,9 @@
 # ones.
 extensions = [
     "recommonmark",  # Allow markdown
-    "sphinx.ext.autodoc",  # Make documentation from 
+    "sphinx.ext.autodoc",  # Make documentation from source
+    "sphinx.ext.napoleon",  # Read docs in Google format
+    "sphinx_autodoc_typehints",  # Allow automatic documentation to see hints
 ]
 
 # Add any paths that contain templates here, relative to this directory.
@@ -41,7 +43,13 @@
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
 # This pattern also affects html_static_path and html_extra_path.
-exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+exclude_patterns = [
+    '_build',
+    'Thumbs.db',
+    '.DS_Store',
+    'test*',
+    '**__pycache__**',
+]
 
 # Enable txt and md files
 source_suffix = {

diff --git a/docs/index.rst b/docs/index.rst
@@ -1,10 +1,5 @@
-.. Agatha documentation master file, created by
-   sphinx-quickstart on Wed Apr 29 10:19:01 2020.
-   You can adapt this file completely to your liking, but it should at least
-   contain the root `toctree` directive.
-
-Welcome to Agatha's documentation!
-==================================
+Agatha: Biomedical Hypothesis Generation
+========================================
 
 .. toctree::
    :maxdepth: 2

diff --git a/docs/modules.rst b/docs/modules.rst
@@ -0,0 +1,7 @@
+agatha
+======
+
+.. toctree::
+   :maxdepth: 4
+
+   agatha
diff --git a/requirements.txt b/requirements.txt
@@ -85,3 +85,5 @@ sphinx
 # Allows for markdown docs
 recommonmark
 
+# Allow sphinx to see type hints
+sphinx-autodoc-typehints