Add new docs theme, and restructure #978
Merged
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.
Summary:
This PR replaces the plain read the docs theme of the documentation with a theme called furo. The theme has a few benefits over the standard RTD theme. It is wider, and uses the browser space better. It has a contents table if the browser window has the room. It has a dark mode. The overall design is cleaner,
In this PR the documentation is also restructured a bit. I'm trying to gradually increase the information and details as you read further instead of dumping a lot of detail right away. I've converted a section of the Introduction chapter into a Key Features chapter. This is then followed by a quick run-through of all the main components.
A preview is available here at least until the PR is merged.
Related Issue(s):
Reviewer's Checklist: