diff options
| author | Jeff Epler <jepler@gmail.com> | 2020-06-14 11:11:44 -0500 |
|---|---|---|
| committer | Jeff Epler <jepler@gmail.com> | 2020-06-14 11:12:35 -0500 |
| commit | 3c3cad5ae6f050150931373e1472098671779973 (patch) | |
| tree | e321a3cb2622fa666eeae9b379fb6d4c97320ba9 | |
| parent | 9285252fbcbe4db654bc69621210883380fb6981 (diff) | |
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).
| -rw-r--r-- | .gitignore | 1 | ||||
| -rw-r--r-- | conf.py | 1 | ||||
| -rw-r--r-- | ports/atmel-samd/README.rst | 2 | ||||
| -rw-r--r-- | shared-bindings/index.rst | 2 |
4 files changed, 4 insertions, 2 deletions
diff --git a/.gitignore b/.gitignore index f5edb89f0..8a773970d 100644 --- a/.gitignore +++ b/.gitignore @@ -53,6 +53,7 @@ _build ###################### genrst/ /autoapi/ +/shared-bindings/**/*.rst # ctags and similar ################### @@ -79,6 +79,7 @@ autoapi_add_toctree_entry = False 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 index a6881902e..0746d1de0 100644 --- 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 index d94177394..bf04ae18b 100644 --- a/shared-bindings/index.rst +++ b/shared-bindings/index.rst @@ -19,5 +19,5 @@ Modules :glob: :maxdepth: 2 - ../autoapi/*/index + ../shared-bindings/*/index help |