takao 0.0.1.dev2

A dark theme for Sphinx.

Takao

Takao is a dark theme for the Sphinx documentation generator.

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:

   pip install takao
   

2. Update html_theme in your Sphinx project configuration:

   html_theme = "takao"
   

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

   make clean
   make html
   

Development

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

Building a wheel

1. Install Python dependencies:

   poetry install
   

2. Install Node.js dependencies:

   npm install
   

3. Build static assets:

   npm run build
   

4. Build the wheel :

   poetry build