Updates to BSK Documentation System #841
Merged
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
sphinx_rtd_theme 3.x is now compatible with newer versions of sphinx. this also works with sphinx 7.x.
We show the BSK version number already in the info box on the main page
schaubh
force-pushed
the
feature/doc_updates
branch
from
79a0ec9 to
bf04376
Compare
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.
Description
The Basilisk documentation is updated to use the new
sphinx_rtd_themeversion 3.x. This allows us to use the latestsphinxpackage. This version created warnings about some scripts being referenced in multiple locations. The example RST file is refactored to present all theexamplesfolder scripts, as well as the contained folders of scripts in particular, in a better way.Verification
Did a clean build of the documentation and no warnings are present.
Documentation
Updated release notes
Future work
None