A dark theme for Sphinx.
Project description
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
-
Install the Python package:
pip install takao
-
Update
html_themein your Sphinx project configuration:html_theme = "takao"
-
Create a clean documentation build in your Sphinx project directory:
make clean make html
Development
Development of Takao requires Python 3.11, uv and Node.js 22.
Set up
-
Install Python dependencies:
uv sync -
Install Node.js dependencies:
npm install
Build a wheel
uv run scripts/build.py
Build the docs
uv run scripts/build_docs.py
Run visual regression tests
Requires Podman.
uv run scripts/run_e2e_tests.py
Update changed snapshots
uv run scripts/run_e2e_tests_update_snapshots.py
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file takao-0.2.2.tar.gz.
File metadata
- Download URL: takao-0.2.2.tar.gz
- Upload date:
- Size: 5.6 MB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: uv/0.9.21 {"installer":{"name":"uv","version":"0.9.21","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":null,"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
6acc1c416c2c16e892a8ddfac19b629a0cf06c19bdce7ced6a8e180c0ff078d0
|
|
| MD5 |
b5a34aef70b10ebb8b78958fbe8aec81
|
|
| BLAKE2b-256 |
f4ee9f744ea9cae02743a9054c48bb0bdeb9d701f1bdbeb4a4e6e7061dac7556
|
File details
Details for the file takao-0.2.2-py3-none-any.whl.
File metadata
- Download URL: takao-0.2.2-py3-none-any.whl
- Upload date:
- Size: 5.6 MB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: uv/0.9.21 {"installer":{"name":"uv","version":"0.9.21","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":null,"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
4454a49401955554f4dcd4b6cb08d03949aef8e35d270456df0a319cdc99efd1
|
|
| MD5 |
6533314dd2668616883cd941e361262c
|
|
| BLAKE2b-256 |
036203c9779d8902f0d279f1d4b32787c8aa48c33ff4192ca6eff3a99bd996b2
|
