Merge pull request #244 from FoamyGuy/docs_api_rst_title

Changes to make fresh project pass precommit and docs build
adafruit · Jan 13, 2025 · 7c2638f · 7c2638f
2 parents 788309c + 39de747
commit 7c2638f
Show file tree

Hide file tree

Showing 2 changed files with 24 additions and 4 deletions.
diff --git a/...ter.__dirname }}/docs/{% if cookiecutter.sphinx_docs in ['y', 'yes'] %}api.rst{% endif %} b/...ter.__dirname }}/docs/{% if cookiecutter.sphinx_docs in ['y', 'yes'] %}api.rst{% endif %}
@@ -4,5 +4,8 @@
 .. If your library file(s) are nested in a directory (e.g. /adafruit_foo/foo.py)
 .. use this format as the module name: "adafruit_foo.foo"
 
+API Reference
+#############
+
 .. automodule:: {% if cookiecutter.library_prefix %}{{ cookiecutter.library_prefix | lower }}_{% endif %}{{ cookiecutter.library_name | lower | replace(" ", "_") }}
     :members:
diff --git a/...ter.__dirname }}/docs/{% if cookiecutter.sphinx_docs in ['y', 'yes'] %}conf.py{% endif %} b/...ter.__dirname }}/docs/{% if cookiecutter.sphinx_docs in ['y', 'yes'] %}conf.py{% endif %}
@@ -29,18 +29,35 @@ extensions = [
 
 autodoc_preserve_defaults = True
 
+{% if cookiecutter.requires_bus_device in ["y", "yes"] and cookiecutter.requires_register in ["y", "yes"] -%}
+intersphinx_mapping = {
+    "python": ("https://docs.python.org/3", None),
+    "BusDevice": ("https://docs.circuitpython.org/projects/busdevice/en/latest/", None),
+    "Register": ("https://docs.circuitpython.org/projects/register/en/latest/", None),
+    "CircuitPython": ("https://docs.circuitpython.org/en/latest/", None),
+}
 
+{% elif cookiecutter.requires_bus_device in ["y", "yes"] -%}
 intersphinx_mapping = {
     "python": ("https://docs.python.org/3", None),
-    {% if cookiecutter.requires_bus_device in ["y", "yes"] -%}
     "BusDevice": ("https://docs.circuitpython.org/projects/busdevice/en/latest/", None),
-    {%- endif %}
-    {% if cookiecutter.requires_register in ["y", "yes"] -%}
+    "CircuitPython": ("https://docs.circuitpython.org/en/latest/", None),
+}
+
+{% elif cookiecutter.requires_register in ["y", "yes"] -%}
+intersphinx_mapping = {
+    "python": ("https://docs.python.org/3", None),
     "Register": ("https://docs.circuitpython.org/projects/register/en/latest/", None),
-    {%- endif %}
     "CircuitPython": ("https://docs.circuitpython.org/en/latest/", None),
 }
 
+{% else -%}
+intersphinx_mapping = {
+    "python": ("https://docs.python.org/3", None),
+    "CircuitPython": ("https://docs.circuitpython.org/en/latest/", None),
+}
+
+{% endif -%}
 # Show the docstring from both the class and its __init__() method.
 autoclass_content = "both"