Small doc fixes#9
Merged
Wrzlprmft merged 2 commits intoneurophysik:masterfrom Feb 12, 2025
Merged
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
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.
Was looking through the docs a bit after neurophysik/jitcode#43 (comment). This fixes some small issues
"`Text <URL>`_"with a single underscore at the end creates a named hyperlink in rst. Creating an anonymous one with a double underscore is better for these one-off links."`text`"uses the default role in Sphinx. This is ok for random text, but classes / functions / etc should be referred to explicitly using":class:`Name`".