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.2.0rc2.tar.gz (307.3 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.2.0rc2-py3-none-any.whl (67.5 kB view details)

Uploaded Python 3

File details

Details for the file sphinx_clarity_theme-1.2.0rc2.tar.gz.

File metadata

  • Download URL: sphinx_clarity_theme-1.2.0rc2.tar.gz
  • Upload date:
  • Size: 307.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: python-requests/2.32.5

File hashes

Hashes for sphinx_clarity_theme-1.2.0rc2.tar.gz
Algorithm Hash digest
SHA256 551c470a040020ec39b523f5fe75229c7891c2c811cabf53de5bc0fd2d2d50b3
MD5 fd88706b2b3e6d16b24f3e18be87b5dc
BLAKE2b-256 6db6c2f9bfc44c931c7f320d1e4cbdee80bd2e67d2c77a43b30ccb054671266b

See more details on using hashes here.

File details

Details for the file sphinx_clarity_theme-1.2.0rc2-py3-none-any.whl.

File metadata

File hashes

Hashes for sphinx_clarity_theme-1.2.0rc2-py3-none-any.whl
Algorithm Hash digest
SHA256 4b21ab743606220767c8643e2eebdd92b4e71e19706a17052b66937f5aa14b73
MD5 6f65f3e7cacfe6e8d8a7b031f53e55ab
BLAKE2b-256 09ad03de57e9177dd99c3dd39510e1190838a48200f3b0d20ffb27d9d4b724db

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