incomplete documentation

NOAA-EMC · Jul 6, 2023 · a01bb68 · a01bb68
1 parent 01cb76d
commit a01bb68
Show file tree

Hide file tree

Showing 5 changed files with 7 additions and 9 deletions.
diff --git a/docs/conf.py b/docs/conf.py
@@ -18,7 +18,9 @@
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
 
 extensions = [
+    "sphinx.ext.napoleon",
     "sphinx.ext.autodoc",
+    "sphinx.ext.viewcode"
 ]
 
 templates_path = ['_templates']
@@ -32,3 +34,5 @@
 html_theme = 'sphinx_rtd_theme'
 html_theme_path = ["_themes", ]
 html_static_path = ['_static']
+
+autoclass_content = 'both'
diff --git a/docs/index.rst b/docs/index.rst
@@ -1,7 +1,4 @@
-.. wxflow documentation master file, created by
-   sphinx-quickstart on Thu Jul  6 11:20:05 2023.
-   You can adapt this file completely to your liking, but it should at least
-   contain the root `toctree` directive.
+.. wxflow documentation master file
 
 wxflow
 ======

diff --git a/docs/logger.rst b/docs/logger.rst
@@ -4,8 +4,4 @@
     :members:
     :show-inheritance:
     :inherited-members:
-.. autoclass:: ColoredFormatter
-    :members:
-    :show-inheritance:
-    :inherited-members:
 .. autofunction:: logit
diff --git a/docs/requirements_docs.txt b/docs/requirements_docs.txt
@@ -1,2 +1,3 @@
 sphinx
 sphinx-autobuild
+sphinx-rtd-theme
diff --git a/setup.cfg b/setup.cfg
@@ -54,7 +54,7 @@ where=src
 
 [options.extras_require]
 dev = pytest>=7; pytest-cov>=3
-docs = sphinx>=4 sphinx_rtd_theme>=0.5
+docs = sphinx>=4; sphinx-autobuild; sphinx_rtd_theme>=0.5
 
 [green]
 file-pattern = test_*.py