Include rubrics in docstring in the local TOC

mhostetter · Jul 24, 2022 · 4619383 · 4619383
1 parent cb25b40
commit 4619383
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 5 deletions.
diff --git a/docs/conf.py b/docs/conf.py
@@ -222,12 +222,16 @@
  "PolyLike": "~typing.PolyLike",
 }
 
-# Sphinx Immaterial API config
+ipython_execlines = ["import math", "import numpy as np", "import galois"]
+
+
+# -- Sphinx Immaterial configs -------------------------------------------------
+
 python_apigen_modules = {
  "galois": "api/galois.",
  "galois.typing": "api/galois.typing.",
 }
-python_type_aliases = autodoc_type_aliases
+
 python_apigen_default_groups = [
  ("class:.*", "Classes"),
  ("data:.*", "Variables"),
@@ -256,12 +260,17 @@
  # (r"method:.*\.is_[a-z,_]*", 31),
  # (r"property:.*\.is_[a-z,_]*", 32),
 ]
+
 python_apigen_order_tiebreaker = "alphabetical"
 python_apigen_case_insensitive_filesystem = False
-python_transform_type_annotations_pep585 = False
 python_apigen_show_base_classes = True
 
-ipython_execlines = ["import math", "import numpy as np", "import galois"]
+python_type_aliases = autodoc_type_aliases
+python_transform_type_annotations_pep585 = False
+
+object_description_options = [
+ ("py:.*", dict(include_rubrics_in_toc=True)),
+]
 
 
 # -- Monkey-patching ---------------------------------------------------------

diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -1,5 +1,5 @@
 sphinx==5
-git+https://github.com/jbms/sphinx-immaterial@8dd1888819e412537de6f182d1ad72a839387a90
+git+https://github.com/jbms/sphinx-immaterial@5e70669e8f42bdd1dfa87c2a5f1879b7ba73d25a
 myst-parser
 sphinx-design
 sphinxcontrib-details-directive