Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add new docs theme, and restructure #978

Merged
merged 10 commits into from
Feb 5, 2022
Merged

Add new docs theme, and restructure #978

merged 10 commits into from
Feb 5, 2022

Conversation

vkbo
Copy link
Owner

@vkbo vkbo commented Feb 1, 2022

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:

  • The header of all files contain a reference to the repository license
  • The overall test coverage is increased or remains the same as before
  • All tests are passing
  • All flake8 checks are passing and the style guide is followed
  • Documentation (as docstrings) is complete and understandable
  • Only files that have been actively changed are committed

@vkbo vkbo added this to the Release 1.6 Beta 2 milestone Feb 1, 2022
@vkbo vkbo merged commit 5ee857f into main Feb 5, 2022
@vkbo vkbo deleted the docs_theme branch February 5, 2022 22:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant