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.1.0.tar.gz (265.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-1.1.0-py3-none-any.whl (61.7 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for sphinx_clarity_theme-1.1.0.tar.gz
Algorithm Hash digest
SHA256 711cc06719a7d8bfac1417e42fbbc433beda7deb7226e94e4ddf7b43aafef791
MD5 63edaec0124bd38775db50f6e79023fc
BLAKE2b-256 56910572992e43d6a22cb77adb518a01410f538765b3695223e0706b0aacac86

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sphinx_clarity_theme-1.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 afc9d57b55626d07913367598d174f2a979a790d098708b4bc8efe24360c685a
MD5 c6932bbed8a19cd5f21354b3c2cd99a2
BLAKE2b-256 448e14d424d19d1f2fb9b47af584bb9dadf4e35a3fe43bd15644913c9464a0e3

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