Fix various issues in docs that cause Sphinx warnings #2842
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
jessica-mitchell
added
S: Normal
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.
This PR fixes several typos and broken links and should resolve many Sphinx warnings that happen at build time.
It should resolve all warnings except the ones about the mc images (resolved in PR #2823), index_stimulation backend (discussed in another PR) and nest.spatial (modified in PR #2588).
To resolve the warnings about the HillTononiModels.ipynb, the markdown cells cannot have lines that begin with a space, so these were removed. Did not seem to affect the equations or output in anyway.
In the connection_management file there were duplicate headings which Sphinx didnt like; the markup for the headers was also not correct and needed fixing. The headings under 'Synapse specification' were changed to 'rule: All to all' to distinguish them from the previous section that also had 'All to all' as heading.
The other files had minor typos and broken links.