Metadata-Version: 2.4
Name: sphinxawesome-theme
Version: 6.0.2
Summary: An awesome theme for the Sphinx documentation generator
Project-URL: documentation, https://sphinxawesome.xyz
Project-URL: homepage, https://sphinxawesome.xyz
Project-URL: issues, https://github.com/kai687/sphinxawesome-theme/issues
Project-URL: repository, https://github.com/kai687/sphinxawesome-theme
Author-email: Kai Welke <kai687@pm.me>
License-File: LICENSE
Classifier: Framework :: Sphinx
Classifier: Framework :: Sphinx :: Theme
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python
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: Programming Language :: Python :: 3.14
Classifier: Topic :: Documentation
Classifier: Topic :: Documentation :: Sphinx
Classifier: Topic :: Software Development :: Documentation
Requires-Python: >=3.10
Requires-Dist: beautifulsoup4<5,>=4.9.1
Requires-Dist: sphinx<10,>7
Description-Content-Type: text/markdown

<h1 align="center">Sphinx awesome theme</h1>

<p align="center">
   <img src="https://img.shields.io/github/license/kai687/sphinxawesome-theme?color=blue&style=for-the-badge" alt="MIT license">
   <img src="https://img.shields.io/pypi/v/sphinxawesome-theme?color=eb5&style=for-the-badge&logo=pypi" alt="PyPI version">
</p>

<p align="center">
   Create beautiful and awesome documentation websites with <a href="https://www.sphinx-doc.org/en/master/">Sphinx</a>.
   See how the theme looks like on <a href="https://sphinxawesome.xyz">sphinxawesome.xyz</a>.
</p>

## Get started

1. Install the theme as a Python package:

   ```sh
   pip install sphinxawesome-theme
   ```

   For more information, see [Install the theme](https://sphinxawesome.xyz/how-to/install/).

1. Add `sphinxawesome_theme` as an HTML theme in your Sphinx configuration file `conf.py`:

   ```python
   html_theme = "sphinxawesome_theme"
   ```

   For more information, see [Add your theme](https://sphinxawesome.xyz/how-to/add/).

## Features

With the Awesome Theme, you can build readable, functional, and beautiful documentation websites.

### Awesome code blocks

- Code block have a **Copy** button for copying the code.
- You can use these additional options in `code-block` directives:

  - `emphasize-added`. Highlight lines that should be added
  - `emphasize-removed`. Highlight lines that should be removed
  - `emphasize-text: TEXT`. Highlight _`TEXT`_ in the code block

### Better headerlinks

Clicking the link icon after headers or captions automatically copies the URL to the clipboard.

### DocSearch

This theme supports the [`sphinx-docsearch`](https://sphinx-docsearch.readthedocs.io/) extension
to replace the built-in search with Algolia DocSearch.
