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.2.tar.gz (92.6 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.2-py3-none-any.whl (68.2 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for sphinx_clarity_theme-1.0.2.tar.gz
Algorithm Hash digest
SHA256 5f4001c7f3886d4dd3df407a00d06c6e620fa02f925590c7d2757b1a2057d5d8
MD5 94436d26a8508441a0dae47ae2125414
BLAKE2b-256 9b8487e93335510c06638a9a2fb4f69b5e0f5a32d1cb28cf405de0d391c18a3c

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sphinx_clarity_theme-1.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 c2cca6ad19fb5ff6d320df7bd378ebdb4c9cc47393a84cd4d341d8d8212ac8a2
MD5 5a8238dc41e6dd436f958ac8e9d9519a
BLAKE2b-256 8d590c56d978ffd9f659103569999da9fb4ff3cb5757e5255d35f7fa949103b8

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