Redesign the documentation with the Furo theme - #106
Merged
Conversation
Replace the default alabaster theme with Furo (modern, zero-config light/dark mode, clean typography), plus sphinx-copybutton (copy-to- clipboard on code blocks) and sphinx-design (feature-card grid, octicons). All three are added to the docs extra. - conf.py: Furo theme, brand accent colors (light/dark), a GitHub footer icon, sphinx-copybutton config, and intersphinx to Python/numpy. - index.rst: rewritten landing page -- PyPI/build/coverage badges, a verified quick-start snippet, and a feature grid (engines, thermo, reactions/redox, kinetics, screening, conformers) that now reflects everything built this session, not just the original DFTB+/xtb feature set the page was written for. - installation.rst / configuration.rst: the ASCII grid tables (which wrapped awkwardly, e.g. mid-word) are replaced with list-table directives for cleaner, more consistent rendering. - docs/_static/custom.css: small polish (card hover lift, tinted inline code). Verified by building locally and visually reviewing every page (landing, API reference, usage, configuration) in both light and dark mode; zero Sphinx warnings.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #106 +/- ##
=======================================
Coverage 97.25% 97.25%
=======================================
Files 31 31
Lines 1895 1895
=======================================
Hits 1843 1843
Misses 52 52
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
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
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.
The docs used Sphinx's default
alabastertheme, which looks dated and plain. This switches to Furo (clean, modern, zero-config light/dark mode) plussphinx-copybuttonandsphinx-design, and refreshes the landing page.Theme
html_theme = "furo", a brand accent color (teal, light + dark variants), a GitHub footer icon,sphinx-copybutton(copy-to-clipboard on every code block), andintersphinxto Python/numpy docs.docsextra only — no runtime/core impact.Landing page (
index.rst)Rewritten: PyPI/Python-version/license/build/coverage badges, a verified quick-start snippet (pulled from
usage.rst, not invented), and asphinx-designfeature-card grid. The old landing page only described the original DFTB+/xtb feature set — the grid now also covers reactions/redox, transition-state kinetics, and the ORCA/cclib/PySCF QM imports built this session, none of which were mentioned before.Tables
installation.rstandconfiguration.rsthad hand-written ASCII grid tables that wrapped awkwardly (e.g.tblite-pythonsplit mid-word across lines). Converted tolist-tabledirectives — cleaner source and more consistent rendering.Verification
Built locally and visually reviewed every page (landing, API reference, usage, configuration) in both light and dark mode via a local preview server + browser screenshots — not just "the build succeeded." Zero Sphinx warnings (also fixed a pre-existing broken
aseintersphinx inventory URL that was about to start warning). Full test suite passes (this PR only touchesdocs/and thedocsextra inpyproject.toml).