Make reference guide and NEST 3 features more visible on Read the Docs #2188
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
I: No breaking change
heplesser
requested changes
Oct 15, 2021
doc/userdoc/release_notes/v3.0/features/random_number_generators.rst
Outdated
Show resolved
Hide resolved
doc/userdoc/release_notes/v3.0/features/recording_simulations.rst
Outdated
Show resolved
Hide resolved
doc/userdoc/release_notes/v3.0/features/recording_simulations.rst
Outdated
Show resolved
Hide resolved
doc/userdoc/release_notes/v3.0/features/stimulation_backends.rst
Outdated
Show resolved
Hide resolved
Co-authored-by: Hans Ekkehard Plesser <hans.ekkehard.plesser@nmbu.no>
heplesser
approved these changes
Oct 15, 2021
|
Straightforward documentation update, therefore merging without second review. |
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.
The NEST 3.0 features and transition guide are difficult to find in the documentation, since they were moved at 3.1 release.
I've added links on the main page to the release notes and the reference guide 2.x vs 3.0 (and in the reference guide there is a link to the release notes so you can find changes for 3.1 and later.)
There is also a link in the guides/index.rst to the 2.x vs 3.0.
I also updated some broken links and added the see also admonition to make links to relevant pages more visible.
Here is a sample of the output: https://nest-test.readthedocs.io/en/add-nest3-links/