Docs improvement #506
Merged
Docs improvement #506
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
…o docs_improvement
a non-complete list of things to do to improve the documentation
a non-complete list of things to do to improve the documentation
…o docs_improvement
|
Nice, could already be merged or first we do those todo's |
tias
approved these changes
Jul 23, 2024
| sphinx>=5.3.0 # cannot be updated due to m2r2 no longer being maintained -> switch to MyST? |
There was a problem hiding this comment.
I know neither of the two, happy to switch to a maintained theme so we can keep sphinx up to date too yes!
|
ah, Wout already reviewed it. Do merge for users to immediately benefit, sphinx theme switch and additional todo's can go in future pull requests. |
m2r2 is not longer actively maintained, causing issues with newer versions of sphinx. As a bonus, cross-referencing is now easier, allowing to directly write links to .rst files instead of their build .html counterparts.
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.
An attempt to fix some of the issues I found with the documentation