DOC: add autoapi

pysat · Apr 13, 2021 · d5d13fd · d5d13fd
1 parent 73b87ae
commit d5d13fd
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 1 deletion.
diff --git a/docs/conf.py b/docs/conf.py
@@ -38,8 +38,11 @@
               'sphinx.ext.ifconfig',
               'sphinx.ext.viewcode',
               'sphinx.ext.githubpages',
+              'autoapi.extension',
               'numpydoc',
               'm2r2']
+# Tell autoapi where the package is
+autoapi_dirs = ['../pysatNASA']
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['.templates']
@@ -56,7 +59,7 @@
 # General information about the project.
 project = 'pysatNASA'
 authors = ', '.join(['Jeff Klenzing', 'Russell Stoneback', 'Jonathon Smith',
-                     'Angeline G Burrell', 'Asher Pembroke', 'Carey Spance'])
+                     'Angeline G Burrell', 'Asher Pembroke', 'Carey Spence'])
 manual_copyright = ', '.join(['2021', authors])
 title = 'pysatNASA Documentation'
 description = 'Tools for NASA CDAWeb instruments.'

diff --git a/test_requirements.txt b/test_requirements.txt
@@ -4,6 +4,7 @@ pytest
 pytest-cov
 pytest-ordering
 sphinx
+sphinx-autoapi
 sphinx_rtd_theme
 numpydoc
 ipython