Skip to content

[doc] Add autolabels so intersphinx can link to anchors like index#install #1787

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jan 24, 2023
Merged

[doc] Add autolabels so intersphinx can link to anchors like index#install #1787

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,3 +55,6 @@ value

# Folder created when using make
cwltool_deps
docs/_build/
docs/autoapi/
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Annoyed by these files that appeared in my git status while testing this PR. Happy to drop this if it's better 👍


3 changes: 3 additions & 0 deletions docs/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,7 @@
extensions = [
"sphinx.ext.autodoc",
"sphinx.ext.autosummary",
"sphinx.ext.autosectionlabel",
"sphinx.ext.intersphinx",
"sphinx.ext.inheritance_diagram",
"autoapi.extension",
Expand All @@ -46,6 +47,8 @@
"sphinxcontrib.autoprogram",
]

autosectionlabel_prefix_document = True
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This adds prefixes to each label, using the document name, reducing risks of conflicts.

https://www.sphinx-doc.org/en/master/usage/extensions/autosectionlabel.html


intersphinx_mapping = {
"python": ("https://docs.python.org/3", None),
"schema_salad": ("https://schema-salad.readthedocs.io/en/stable/", None),
Expand Down