Use the sphinx-better-subsection extension to use explicit targets for section permalinks #38
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…r section permalinks As that Python package requires ≥3.7, this theme will now too. That's acceptable in the development contexts in which we generate docs, which should be using newer Pythons anyway. c.f. <nextstrain/docs.nextstrain.org@57fe1888#all_commit_comments>
tsibley
referenced
this pull request
in nextstrain/docs.nextstrain.org
Jul 25, 2023
This is consistent with the existing documentation style guide and a similar Snakemake style guide¹ written by @tsibley. This also allows for the addition of a table of contents, which is done here. I looked into making the section links future-proof to wording changes, however could not find a good solution. The closest is using :ref: roles which adds separately defined links to to the section titles, but those links aren't used by the TOC or header links themselves. ¹ https://github.com/blab/styleguide/blob/6aa5d7aa42acfa97e57a5ee05a4175f158502cac/nextstrain-builds.md
victorlin
approved these changes
Jul 25, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
As that Python package requires ≥3.7, this theme will now too. That's acceptable in the development contexts in which we generate docs, which should be using newer Pythons anyway.
c.f. nextstrain/docs.nextstrain.org@57fe1888#all_commit_comments
Testing