Skip to content

Redesign the documentation with the Furo theme - #106

Merged
galjos merged 1 commit into
mainfrom
redesign-docs-theme
Jul 8, 2026
Merged

Redesign the documentation with the Furo theme#106
galjos merged 1 commit into
mainfrom
redesign-docs-theme

Conversation

@galjos

@galjos galjos commented Jul 8, 2026

Copy link
Copy Markdown
Member

The docs used Sphinx's default alabaster theme, which looks dated and plain. This switches to Furo (clean, modern, zero-config light/dark mode) plus sphinx-copybutton and sphinx-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), and intersphinx to Python/numpy docs.
  • All new deps are added to the docs extra 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 a sphinx-design feature-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.rst and configuration.rst had hand-written ASCII grid tables that wrapped awkwardly (e.g. tblite-python split mid-word across lines). Converted to list-table directives — 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 ase intersphinx inventory URL that was about to start warning). Full test suite passes (this PR only touches docs/ and the docs extra in pyproject.toml).

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

codecov Bot commented Jul 8, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 97.25%. Comparing base (3e3307a) to head (ccf8897).

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           
Flag Coverage Δ
unittests 97.25% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@galjos
galjos merged commit 3c30da7 into main Jul 8, 2026
5 checks passed
@galjos
galjos deleted the redesign-docs-theme branch July 8, 2026 07:12
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