Fix autodoc

qutech · Nov 6, 2024 · 6938315 · 6938315
1 parent 430d2c6
commit 6938315
Show file tree

Hide file tree

Showing 6 changed files with 14 additions and 89 deletions.
diff --git a/doc/source/api.rst b/doc/source/api.rst
@@ -0,0 +1,8 @@
+API
+===
+
+.. autosummary::
+   :toctree: generated
+   :recursive:
+
+   filter_functions
diff --git a/doc/source/conf.py b/doc/source/conf.py
@@ -38,27 +38,28 @@
     'nbsphinx',
     'sphinx.ext.mathjax',
     'sphinx.ext.todo',
+    'sphinx.ext.autodoc',
     'sphinx.ext.autosummary',
     'numpydoc',
     'sphinx.ext.extlinks',
     'sphinx.ext.viewcode',
     'sphinx.ext.ifconfig',
     'sphinx.ext.napoleon',
     'sphinx.ext.intersphinx',
-    #'sphinxcontrib.apidoc',
+    'sphinxcontrib.apidoc',
     #'IPython.sphinxext.ipython_console_highlighting',
     #'IPython.sphinxext.ipython_directive',
     #'matplotlib.sphinxext.only_directives',
     #'matplotlib.sphinxext.plot_directive',
     #'matplotlib.sphinxext.mathmpl',
-    #'sphinx.ext.autodoc',
     #'sphinx.ext.doctest',
 ]
 
 # Apidoc config
 apidoc_module_dir = '../../filter_functions'
 apidoc_excluded_paths = ['../tests']
 apidoc_separate_modules = True
+apidoc_module_first = True
 
 # Numpydoc settings
 numpydoc_show_inherited_class_members = False

diff --git a/doc/source/filter_functions.rst b/doc/source/filter_functions.rst
diff --git a/doc/source/index.rst b/doc/source/index.rst
@@ -23,7 +23,7 @@ Documentation
    :numbered:
 
    examples/examples
-   filter_functions API Documentation <filter_functions>
+   filter_functions API Documentation <api>
 
 Indices and tables
 ==================

diff --git a/environment.yml b/environment.yml
@@ -6,6 +6,7 @@ channels:
 dependencies:
   - python >= 3.9
   - qutip
+  - pandoc
   - pip
 
 prefix: /home/docs/.conda/envs/filter_functions
diff --git a/setup.py b/setup.py
@@ -19,7 +19,7 @@ def extract_version(version_file):
 extras_require = {'plotting': ['matplotlib'],
                   'bloch_sphere_visualization': ['qutip', 'matplotlib'],
                   'doc': ['jupyter', 'nbsphinx', 'numpydoc', 'sphinx', 'sphinx_rtd_theme',
-                          'ipympl', 'qutip-qip', 'qutip-qtrl', 'numpy<2'],
+                          'sphinxcontrib-apidoc', 'ipympl', 'qutip-qip', 'qutip-qtrl', 'numpy<2'],
                   'tests': ['pytest>=4.6', 'pytest-cov', 'codecov']}
 
 extras_require['all'] = list({dep for deps in extras_require.values() for dep in deps})