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.0.0.tar.gz (388.4 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.0.0-py3-none-any.whl (71.0 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for sphinx_clarity_theme-2.0.0.tar.gz
Algorithm Hash digest
SHA256 f50edefad66ec2020c99a1159a4d5a1d7eeca47ec7801047e972d54a503084c4
MD5 e318c4b628bfbc95950d66d66eedb3f0
BLAKE2b-256 2651cc9ef6d7f89b99cf6ba3f8019d19a7b84d46319c3c9388c9d03b67a3ccf6

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sphinx_clarity_theme-2.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 16c82f785aa12527152e303be6af21c2808bf1af66748f3531bbe1ac062e4879
MD5 96ca184a1f829103cd6dd9d37321798a
BLAKE2b-256 ce7415bebc2f497134c106f48f55e4a46e52fc9f07c8bf7bba59837281bc0341

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