add class links to docs ipynb, change docs sorting for readthedocs/sp…

…hinx
ericfell · Jan 20, 2024 · ed24f89 · ed24f89
1 parent e354364
commit ed24f89
Show file tree

Hide file tree

Showing 2 changed files with 37 additions and 35 deletions.
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -22,7 +22,6 @@
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
 
 
-
 extensions = [
     'sphinx.ext.autodoc',
     'sphinx.ext.viewcode',
@@ -35,9 +34,12 @@
 exclude_patterns = []
 
 
-
 # -- Options for HTML output -------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
 
 html_theme = "sphinx_rtd_theme"
 html_static_path = ['_static']
+
+# sort documentation by source code order (not alphabetically)
+# https://www.sphinx-doc.org/en/master/usage/extensions/autodoc.html#confval-autodoc_member_order
+autodoc_member_order = 'bysource'