Fix non-unique heading anchors on changelog doc page #1942
Closed
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
atugushev
added
docs
atugushev
force-pushed
the
non-unique-changelog-heading-1935
branch
from
8546b12
to
00c879a
Compare
atugushev
force-pushed
the
non-unique-changelog-heading-1935
branch
from
00c879a
to
040c7c5
Compare
webknjaz
requested changes
Aug 1, 2023
There was a problem hiding this comment.
The idea is good, but the implementation needs polishing:
- The proper thing to do here is to use the extension interface and not throw arbitrarily loaded modules in the docs dir. Use
_ext/and make sphinx load it as an extension with it's ownsetup(). - There's several maintenance/functional improvements in the comments below.
- Finally, let's try to drop the dates from anchors, as it'd be cleaner and more predictable to link releases. Links like https://cheroot.cherrypy.dev/en/latest/history/#v11-0-0 and https://setuptools.pypa.io/en/latest/history.html#v68-0-0 are nicer and can be constructed by guessing from the release versions/repo tags.
| @@ -0,0 +1,34 @@ | |||
| from __future__ import annotations | |||
There was a problem hiding this comment.
Move this to the _ext/ subir per convention.
| @@ -57,3 +64,9 @@ | |||
| ] | |||
|
|
|||
| suppress_warnings = ["myst.xref_missing"] | |||
|
|
|||
|
|
|||
| def setup(app: Sphinx) -> None: | |||
There was a problem hiding this comment.
Don't add setup() here but put it into an extension under _ext/.
Also, it should return a dict.
|
|
||
|
|
||
| def setup(app: Sphinx) -> None: | ||
| from docs.utils import TransformSectionIdToName |
There was a problem hiding this comment.
This is not needed, especially upon moving to the extension. Just add the extension to the list above and Sphinx will load it through the standard means.
| from sphinx.util import logging | ||
| from sphinx.util.console import bold | ||
|
|
||
| # Add the docs/ directory to sys.path to be able to import utils | ||
| docs_dir = os.path.dirname(os.path.dirname(__file__)) |
There was a problem hiding this comment.
Plz use pathlib and only convert to str on insert.
| from importlib.metadata import version as get_version | ||
| from pathlib import Path | ||
|
|
||
| from sphinx.application import Sphinx |
There was a problem hiding this comment.
Obviously, this won't be necessary upon moving to a proper extension.
| numerical_id = re.compile(r"^id[0-9]+$") | ||
|
|
||
|
|
||
| class TransformSectionIdToName(SphinxTransform): # type: ignore[misc] |
|
|
||
| default_priority = SortIds.default_priority + 1 | ||
|
|
||
| def apply(self, **kwargs: Any) -> Any: |
Comment on lines
+25
to
+31
| if not node_ids: | ||
| return False | ||
|
|
||
| if len(node_ids) != 1: | ||
| return False | ||
|
|
||
| return bool(numerical_id.match(node_ids[0])) |
There was a problem hiding this comment.
This can be simplified:
Suggested change
| if not node_ids: | |
| return False | |
| if len(node_ids) != 1: | |
| return False | |
| return bool(numerical_id.match(node_ids[0])) | |
| node_has_single_id = len(node_ids) == 1 | |
| return node_has_single_id and | |
| numerical_id.match(node_ids[0]) is not None |
| return bool(numerical_id.match(node_ids[0])) | ||
|
|
||
| def _transform_id_to_name(self, node: nodes.section) -> None: | ||
| node["ids"] = [nodes.make_id("id " + name) for name in node["names"]] |
There was a problem hiding this comment.
String concatenation is slow.
Suggested change
| node["ids"] = [nodes.make_id("id " + name) for name in node["names"]] | |
| node["ids"] = [nodes.make_id(f"id {node_name}") for node_name in node["names"]] |
There was a problem hiding this comment.
Don't add Python modules among the normal documents.
4 tasks
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.
Fixes #1935.
Contributor checklist
Maintainer checklist
backwards incompatible,feature,enhancement,deprecation,bug,dependency,docsorskip-changelogas they determine changelog listing.