Skip to main content

A clean and professional documentation theme for Sphinx. Modern design with light/dark mode, responsive layout, and beautiful typography.

Project description

Clarity Theme for Sphinx

Live demo GitHub repository Support forum MIT License Sphinx Tailwind CSS PyPI version Python versions

A clean and professional documentation theme for Sphinx. Modern design with light/dark mode, responsive layout, and beautiful typography.

Clean, modern typography · Optimized spacing for long pages
Excellent readability on desktop and mobile · Designed specifically for Sphinx documentation

Clarity Sphinx theme preview

📁 Directory structure

  • docs/ - theme documentation sources
  • demo/ - built docs/ as a demo
  • preview/ - theme screenshots
  • src/sphinx_clarity_theme - theme sources
  • tests/
  • CHANGELOG.md
  • pyproject.toml
  • README.md - this file
  • LICENSE.md

🚀 Quickstart

The theme is dual-licensed under the free MIT or Commercial License. For commercial use, the Commercial License is recommended. It offers bonus assets, no attribution requirements, and priority support.

Consider purchasing a license at https://readcraft.io/sphinx-clarity-theme to fund the development 🙏

  1. Install package using the preferred Python package manager. E.g.,
    • pip: pip install sphinx_clarity_theme
    • uv: uv add sphinx_clarity_theme
  2. Update your conf.py:
    html_theme = "sphinx_clarity_theme"
    

📚 Full documentation:

https://readcraft.io/sphinx-clarity-theme/docs/

💬 Support and Contact

⚖️ License and Legal

Dual-licensed under the MIT License or Commercial License. For commercial use, the Commercial License is recommended. Plus, it includes bonus assets, no attribution requirements, and priority support and updates. See https://readcraft.io/license for details.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

sphinx_clarity_theme-1.0.1.post3.tar.gz (56.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

sphinx_clarity_theme-1.0.1.post3-py3-none-any.whl (31.9 kB view details)

Uploaded Python 3

File details

Details for the file sphinx_clarity_theme-1.0.1.post3.tar.gz.

File metadata

File hashes

Hashes for sphinx_clarity_theme-1.0.1.post3.tar.gz
Algorithm Hash digest
SHA256 54dbd4a618e40d440d6ce12ada8cd9cb9e73908431d9522b6709b123c095f031
MD5 3eb059b1d1f46fc175444084f28b51fb
BLAKE2b-256 9979ebc73656f54527b3a486659bc14f48f81c0127a90a17a7a9ca107db2ca8c

See more details on using hashes here.

File details

Details for the file sphinx_clarity_theme-1.0.1.post3-py3-none-any.whl.

File metadata

File hashes

Hashes for sphinx_clarity_theme-1.0.1.post3-py3-none-any.whl
Algorithm Hash digest
SHA256 8596618d8f766028fb2fa905c845e4491292cf2d192a180e310dd143d0dd0556
MD5 f1cdad19f6882e5ed813ab10e84a41b0
BLAKE2b-256 440b78e72e7af0822d793043c35ae97a1970b6bc0190cf756ec52b3577979fb0

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page