Documentation better linking of symbols to files and cleanup #760
Conversation
This file contains hidden or 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
m-reuter
reviewed
Jan 5, 2026
m-reuter
reviewed
Jan 5, 2026
m-reuter
reviewed
Jan 5, 2026
- pyproject - remove superfluous dependencies from the doc extra - sphinx_ext/resolve_links - move the linkcode_resolve function from conf to its own file, make it into a class and let it take the github url and the branch name (so multiple doc branches are supported) - Fix some links that were not found and causing errors and some links that were faulty - FastSurferCNN/version - adapt for use with StringIO instead of TextIO - formatting - Adapt conf to new resolve_links and version script integration - fix typos, formatting and typing in sphinx_ext/fix_links/resolve and doc/index.rst
dkuegler
force-pushed
the
feature/doc-linking
branch
from
18cea0a to
6b3c038
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
This PR fixes an issue with the doc build, where symbols could not be found/links could not be created in the CC documentation.
As a side effect, this PR also fixes some other minor things in the documentation build, including linking to the correct branch in the stable doc, getting rid of extra dependencies in the doc optional dependencies, and adding links in other spots when possible.