Fix autodoc

whylabs · Mar 5, 2021 · 6888034 · 6888034
1 parent a558260
commit 6888034
Show file tree

Hide file tree

Showing 4 changed files with 13 additions and 39 deletions.
diff --git a/docs/changelog.rst b/docs/changelog.rst
diff --git a/docs/conf.py b/docs/conf.py
@@ -65,44 +65,26 @@
 # Add any Sphinx extension module names here, as strings. They can be extensions
 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
 extensions = [
+    "autoapi.extension",
     "sphinx.ext.autodoc",
-    "sphinx.ext.intersphinx",
-    "sphinx.ext.todo",
-    "sphinx.ext.autosummary",
     "sphinx.ext.viewcode",
+    "sphinx.ext.napoleon",
+    "sphinx.ext.viewcode",
+    "sphinx_autodoc_typehints",
     "sphinx.ext.coverage",
     "sphinx.ext.doctest",
     "sphinx.ext.ifconfig",
     "sphinx.ext.mathjax",
-    "sphinx.ext.napoleon",
-    "sphinx_rtd_theme",
-    "recommonmark",
 ]
 
+autoapi_type = 'python'
+autoapi_dirs = ['../src']
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ["_templates"]
 
-
-# To configure AutoStructify
-def setup(app):
-    from recommonmark.transform import AutoStructify
-
-    app.add_config_value(
-        "recommonmark_config",
-        {
-            "auto_toc_tree_section": "Contents",
-            "enable_eval_rst": True,
-            "enable_math": True,
-            "enable_inline_math": True,
-        },
-        True,
-    )
-    app.add_transform(AutoStructify)
-
-
 # The suffix of source filenames.
-source_suffix = [".rst", ".md"]
+source_suffix = [".rst"]
 
 # The encoding of source files.
 # source_encoding = 'utf-8-sig'
@@ -247,7 +229,6 @@ def setup(app):
 # Output file base name for HTML help builder.
 htmlhelp_basename = "whylogs_python-doc"
 
-
 # -- Options for LaTeX output --------------------------------------------------
 
 latex_elements = {

diff --git a/docs/index.rst b/docs/index.rst
@@ -1,6 +1,6 @@
-.. whylogs documentation master file
+:github_url: https://github.com/whylabs/whylogs
 
-whylogs
+whylogs API reference
 ==================
 
 *Profile and monitor your ML data pipeline end-to-end*
@@ -15,13 +15,12 @@ your data, read our :ref:`intro` and our :ref:`getting_started` guide.
    This site is a work in progress. If you have questions, ask them in our `Slack channel <http://join.slack.whylabs.ai/>`__!
 
 .. toctree::
-    :maxdepth: 5
+    :maxdepth: 2
 
     overview
     getting_started
     concepts
-    auto_examples/index
-    Changelog <changelog>
+    Examples <auto_examples/index>
     License <license>
 
 Indices and tables
@@ -30,8 +29,3 @@ Indices and tables
 * :ref:`genindex`
 * :ref:`modindex`
 * :ref:`search`
-
-.. toctree::
-    :maxdepth: 2
-
-    api/modules
diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -7,4 +7,5 @@ sphinx-autoapi>=1.4.0
 autoapi>=2.0.1
 sphinx-autorun >= 1.1.1
 sphinx-gallery >= 0.8.0
-pillow
+pillow
+sphinx_autodoc_typehints