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.0rc1.tar.gz (234.2 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.0rc1-py3-none-any.whl (66.1 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for sphinx_clarity_theme-1.2.0rc1.tar.gz
Algorithm Hash digest
SHA256 3146b6b7376bc444501c013271e8f5ad9e8cb626389f2f85f16fdeefe0f68474
MD5 9dc9df40ebad4382b4a0f87f9b60a0de
BLAKE2b-256 91fa0a7a585c8a493ee3d3440f369741400e50928a4f1373d527ca438b6339cc

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sphinx_clarity_theme-1.2.0rc1-py3-none-any.whl
Algorithm Hash digest
SHA256 cc01800b87db6bf6290e9e125d4ad7375076e2ad9f8ceda62966225ea9079ce8
MD5 ab4d427f75f11f7fc085025e33e18746
BLAKE2b-256 d53a7f11b49f142ee91107c45e1b89766e413c3a857278bf632c101c59223921

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