Metadata-Version: 2.4
Name: sphinx-clarity
Version: 1.0.0
Summary: A clean Sphinx theme with phosphor-green / UV-violet dual-accent color system
Project-URL: Homepage, https://github.com/relicloops/clarity
Project-URL: Documentation, https://github.com/relicloops/clarity
Project-URL: Repository, https://github.com/relicloops/clarity
Project-URL: Issues, https://github.com/relicloops/clarity/issues
Author-email: Simone Del Popolo <inbox@simonedelpopolo.com>
License-Expression: Apache-2.0
License-File: LICENSE
Keywords: dark-mode,documentation,light-mode,sphinx,theme
Classifier: Development Status :: 5 - Production/Stable
Classifier: Framework :: Sphinx
Classifier: Framework :: Sphinx :: Theme
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Documentation
Classifier: Topic :: Documentation :: Sphinx
Classifier: Topic :: Software Development :: Documentation
Requires-Python: >=3.10
Requires-Dist: sphinx>=7.0
Description-Content-Type: text/markdown

# Clarity

A clean Sphinx theme with phosphor-green / UV-violet dual-accent color system.

## Features

- **Dual-accent color system** -- phosphor-green (`#39ff14`) in dark mode, UV-violet (`#7b2ff7`) in light mode
- **Dark / light / system** theme toggle with `localStorage` persistence
- **Two font stacks** -- default (Orbitron / Inter / Intel One Mono) or system (native OS fonts)
- **Custom Pygments styles** -- `clarity-dark` and `clarity-light` with phosphor-tinted syntax colors
- **Three-column layout** -- sidebar, content, table of contents
- **Responsive** -- desktop, tablet, mobile breakpoints
- **Keyboard navigation** -- arrow keys (prev/next), `/` (search)
- **Code block language badges**
- **Dual logo support** -- separate images for dark and light modes

## Install

```bash
pip install sphinx-clarity
```

## Usage

```python
# conf.py
html_theme = "clarity"
html_theme_options = {
    "default_theme": "system",
    "font_stack": "default",      # or "system"
    "navigation_with_keys": True,
    "show_toc_level": 2,
}
```

## License

Apache-2.0
