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-2.1.0.tar.gz (389.8 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-2.1.0-py3-none-any.whl (73.0 kB view details)

Uploaded Python 3

File details

Details for the file sphinx_clarity_theme-2.1.0.tar.gz.

File metadata

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

File hashes

Hashes for sphinx_clarity_theme-2.1.0.tar.gz
Algorithm Hash digest
SHA256 8ba8ddb7d50d1b040e63b2b707a1ce9acc1bb4f66b796b4268557216b6eba9e3
MD5 50be96d8eeaf2f56274efcc7bb194c81
BLAKE2b-256 deaf2e95cef7f4c6a23056dff865361bbf305a006c16f039605d9de9d325f645

See more details on using hashes here.

File details

Details for the file sphinx_clarity_theme-2.1.0-py3-none-any.whl.

File metadata

File hashes

Hashes for sphinx_clarity_theme-2.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 66a946615f0a7366b21956028ea5fdd5991c6c7ae7c9920c0d7f8bfc9b13fb9c
MD5 8d75535f35b47a7c7b0f054345027c6d
BLAKE2b-256 a0d33c44e95b7eb8bbecb2b2bd411f0643ce410671d0101ff79b2e3352c111e3

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