Skip to content

Commit 3c3cad5

Browse files
committed
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).
1 parent 9285252 commit 3c3cad5

File tree

4 files changed

+4
-2
lines changed

4 files changed

+4
-2
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,7 @@ _build
5353
######################
5454
genrst/
5555
/autoapi/
56+
/shared-bindings/**/*.rst
5657

5758
# ctags and similar
5859
###################

conf.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -79,6 +79,7 @@
7979
autoapi_options = ['members', 'undoc-members', 'private-members', 'show-inheritance', 'special-members', 'show-module-summary']
8080
autoapi_template_dir = 'docs/autoapi/templates'
8181
autoapi_python_use_implicit_namespaces = True
82+
autoapi_root = "shared-bindings"
8283

8384
# The encoding of source files.
8485
#source_encoding = 'utf-8-sig'

ports/atmel-samd/README.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,4 +21,4 @@ Port Specific modules
2121
---------------------
2222

2323
.. toctree::
24-
../../autoapi/samd/index
24+
../../shared-bindings/samd/index

shared-bindings/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,5 +19,5 @@ Modules
1919
:glob:
2020
:maxdepth: 2
2121

22-
../autoapi/*/index
22+
../shared-bindings/*/index
2323
help

0 commit comments

Comments
 (0)