docs: Improve 5.0.x <-> main branch doc linkrot

This improves, but does not entirely fix, the broken links that result from the autoapi change. It fixes module-level links, but class links still do not work (e.g., /shared-bindings/displayio/Palette.html (5.0.x) is now just /shared-bindings/displayio/#displayio.Palette).
rhooper · Jun 14, 2020 · 3c3cad5 · 3c3cad5
1 parent 9285252
commit 3c3cad5
Show file tree

Hide file tree

Showing 4 changed files with 4 additions and 2 deletions.
diff --git a/.gitignore b/.gitignore
@@ -53,6 +53,7 @@ _build
 ######################
 genrst/
 /autoapi/
+/shared-bindings/**/*.rst
 
 # ctags and similar
 ###################

diff --git a/conf.py b/conf.py
@@ -79,6 +79,7 @@
 autoapi_options = ['members', 'undoc-members', 'private-members', 'show-inheritance', 'special-members', 'show-module-summary']
 autoapi_template_dir = 'docs/autoapi/templates'
 autoapi_python_use_implicit_namespaces = True
+autoapi_root = "shared-bindings"
 
 # The encoding of source files.
 #source_encoding = 'utf-8-sig'

diff --git a/ports/atmel-samd/README.rst b/ports/atmel-samd/README.rst
@@ -21,4 +21,4 @@ Port Specific modules
 ---------------------
 
 .. toctree::
-    ../../autoapi/samd/index
+    ../../shared-bindings/samd/index
diff --git a/shared-bindings/index.rst b/shared-bindings/index.rst
@@ -19,5 +19,5 @@ Modules
     :glob:
     :maxdepth: 2
 
-    ../autoapi/*/index
+    ../shared-bindings/*/index
     help