reupen / takao

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.

Demo

For a demo of the theme, see https://columns-ui-sdk.readthedocs.io.

Licence

Takao uses the MIT licence.

Distributions of Takao include the Inter font, which uses the SIL Open Font Licence.

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.

Set up

1. Install Python dependencies:

   poetry install

2. Install Node.js dependencies:

   npm install

Build a wheel

poetry run python scripts/build.py

Build the docs

poetry run python scripts/build_docs.py

Run visual regression tests

Requires Podman.

poetry run python scripts/run_e2e_tests.py

Update changed snapshots

poetry run python scripts/run_e2e_tests_update_snapshots.py