sphinx_clarity_theme 1.0.2
A clean and professional documentation theme for Sphinx. Modern design with light/dark mode, responsive layout, and beautiful typography.
Requires Python: >=3.11

<div align="center">

# Clarity Theme for Sphinx

[![Live demo](https://img.shields.io/badge/Live%20demo-%2334D399)](https://readcraft.io/sphinx-clarity-theme/demo/)
[![GitHub repository](https://img.shields.io/badge/Sources-%23181717?logo=github&logoColor=white)](https://github.com/ReadCraft-io/sphinx-clarity-theme)
[![Support forum](https://img.shields.io/badge/Discussions-%23346CB0?logo=github&logoColor=white)](https://github.com/orgs/ReadCraft-io/discussions)
[![MIT License](https://img.shields.io/badge/License-MIT-%23A6CC00)](https://opensource.org/licenses/MIT)
[![Sphinx](https://img.shields.io/badge/Sphinx%20doc-%23346CB0?logo=sphinx&logoColor=white)](https://www.sphinx-doc.org/)
[![Tailwind CSS](https://img.shields.io/badge/Tailwind%20CSS-%2338B2AC?logo=tailwindcss&logoColor=white)](https://tailwindcss.com)
[![PyPI version](https://img.shields.io/pypi/v/sphinx-clarity-theme)](https://pypi.org/project/sphinx-clarity-theme/)
[![Python versions](https://img.shields.io/pypi/pyversions/sphinx-clarity-theme)](https://pypi.org/project/sphinx-clarity-theme/)

**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_

<!-- Screenshot -->
<a href="https://readcraft.io/sphinx-clarity-theme" target="_blank">
  <p align="center">
     <img src="https://readcraft.io/sphinx-clarity-theme/preview/screenshot1.png" alt="Clarity Sphinx theme preview" width="800">
  </p>
</a>

</div>

## 📁 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`
1. Update your `conf.py`:
   ```python
   html_theme = "sphinx_clarity_theme"
   ```

## 📚 Full documentation:

https://readcraft.io/sphinx-clarity-theme/docs/

## 💬 Support and Contact

- Commercial license holders get priority email support at readcraft@readcraft.io.
- Everybody including Community users (MIT License) receive best effort support through our public forum https://github.com/orgs/ReadCraft-io/discussions.

## ⚖️ 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.