djsundog/circuitpython
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

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

Browse Source 
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).
This commit is contained in:
Jeff Epler 2020-06-14 11:11:44 -05:00
parent 9285252fbc
commit 3c3cad5ae6
4 changed files with 4 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
.gitignore vendored
View File

@ -53,6 +53,7 @@ _build
###################### ######################
genrst/ genrst/
/autoapi/ /autoapi/
/shared-bindings/**/*.rst
# ctags and similar # ctags and similar
################### ###################

1
conf.py
View File

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

2
ports/atmel-samd/README.rst
View File

@ -21,4 +21,4 @@ Port Specific modules
--------------------- ---------------------
.. toctree:: .. toctree::
../../autoapi/samd/index ../../shared-bindings/samd/index

2
shared-bindings/index.rst
View File

@ -19,5 +19,5 @@ Modules
:glob: :glob:
:maxdepth: 2 :maxdepth: 2
../autoapi/*/index ../shared-bindings/*/index
help help