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_theme
in 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, Poetry and Node.js 18.
Set up
-
Install Python dependencies:
poetry install
-
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
Project details
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
File details
Details for the file takao-0.2.1.tar.gz
.
File metadata
- Download URL: takao-0.2.1.tar.gz
- Upload date:
- Size: 5.3 MB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.7.0 CPython/3.12.0 Windows/11
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | f4f5b670bb7c49987f1af92edcdd67267c0e314db9fa801fdfe5c60573cf8388 |
|
MD5 | 97c608fc7b1c443f7f9e924b723c3b30 |
|
BLAKE2b-256 | 23640befa2068dc30fcb5193a454d95f3165f7553a4c8b453ca0ede2331b1662 |
File details
Details for the file takao-0.2.1-py3-none-any.whl
.
File metadata
- Download URL: takao-0.2.1-py3-none-any.whl
- Upload date:
- Size: 5.3 MB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.7.0 CPython/3.12.0 Windows/11
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 85b7713255b330a801c8fe64b15e6fd002fb3ca985a60a9afca658355972abc5 |
|
MD5 | a387835aec0c0327578600c4121e16bd |
|
BLAKE2b-256 | 8496e21b9618f2a434eff72cc5f3fa474a812d894b21c8fc8e81cc1e524d6d0e |