Metadata-Version: 2.1
Name: takao
Version: 0.0.1.dev2
Summary: A dark theme for Sphinx.
Home-page: https://github.com/reupen/takao
License: MIT
Author: Reupen Shah
Requires-Python: >=3.10,<4.0
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Requires-Dist: sphinx (>=4)
Project-URL: Repository, https://github.com/reupen/takao
Description-Content-Type: text/markdown

# Takao

Takao is a dark theme for the
[Sphinx documentation generator](https://www.sphinx-doc.org/en/master/).

I created it mainly for my own projects. Feel free to try it and open an issue
if you have any problems.

## Installation

1. Install the Python package:

   ```shell
   pip install takao
   ```

2. Update `html_theme` in your Sphinx project configuration:

   ```python
   html_theme = "takao"
   ```

3. Create a clean documentation build in your Sphinx project directory:

   ```shell
   make clean
   make html
   ```

## Development

Development of Takao requires Python 3.11, Poetry and Node.js 18.

### Building a wheel

1. Install Python dependencies:

   ```shell
   poetry install
   ```

2. Install Node.js dependencies:

   ```shell
   npm install
   ```

3. Build static assets:

   ```shell
   npm run build
   ```

4. Build the wheel :
   ```shell
   poetry build
   ```

