Update documentation.

OxfordRSE · Nov 13, 2024 · 6af74f0 · 6af74f0
1 parent 9853a2c
commit 6af74f0
Show file tree

Hide file tree

Showing 4 changed files with 18 additions and 7 deletions.
diff --git a/.gitignore b/.gitignore
@@ -1,5 +1,5 @@
 .DS_Store
 __pycache__/
 .venv/
-docs/source/_autosummary/
+docs/source/reference/
 docs/build/
diff --git a/docs/source/code.rst b/docs/source/code.rst
@@ -1,9 +1,13 @@
 
-Code Reference
-==============
+Reference
+==========
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents
+
+   reference/l2gv2
 
 .. autosummary::
-   :toctree: _autosummary
+   :toctree: reference
    :recursive:
-
-   l2gv2
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -15,6 +15,14 @@
 
 extensions = ["sphinx_markdown_builder", "sphinx.ext.autodoc", "sphinx.ext.autosummary"]
 
+autosummary_generate = True
+autodoc_default_options = {
+    "members": True,
+    "undoc-members": True, 
+    "inherited-members": True,
+    "show-inheritance": True,
+}
+
 templates_path = ["_templates"]
 exclude_patterns = []
 

diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -11,4 +11,3 @@ l2gv2 documentation
 
    intro
    code
-