Modernize RTD documentation with Furo theme and improved structure - #15
Merged
Merged
Conversation
…sions - Switch from Alabaster to Furo theme for modern look, dark mode, and responsive layout - Add sphinx-copybutton, sphinx-design, intersphinx, and opengraph extensions - Refactor comparison section to use tabbed layouts instead of long sequential code blocks - Fix user_guide.rst title mismatch (was "Installation", now "User Guide") - Replace redundant modules.rst/cruds.rst chain with single api.rst - Add CI, RTD, and PyPI version badges to index page - Use code-block:: console for shell commands (proper highlighting) - Expand development.rst with testing, code quality, and issue filing sections - Fix copyright year to be dynamic (2020-current) - Fix project.urls to use https for RTD links - Configure .readthedocs.yaml to install package with [rtd] extras Co-authored-by: Cursor <cursoragent@cursor.com>
johnbrandborg
force-pushed
the
docs/improve-documentation-and-presentation
branch
from
February 20, 2026 12:53
a7e9ad0 to
c777429
Compare
|
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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
[rtd]extras, and shell commands usecode-block:: consolefor proper highlighting.Test plan
Made with Cursor