https://github.com/reupen/takao
A dark theme for Sphinx
https://github.com/reupen/takao
python sphinx-theme
Last synced: 5 months ago
JSON representation
A dark theme for Sphinx
- Host: GitHub
- URL: https://github.com/reupen/takao
- Owner: reupen
- License: mit
- Created: 2023-02-11T22:12:33.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-12-23T17:28:40.000Z (5 months ago)
- Last Synced: 2024-12-23T18:30:37.029Z (5 months ago)
- Topics: python, sphinx-theme
- Language: CSS
- Homepage:
- Size: 20.1 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Takao
Takao is a dark theme for the
[Sphinx documentation generator](https://www.sphinx-doc.org).
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](https://github.com/rsms/inter),
which
[uses the SIL Open Font Licence](https://github.com/rsms/inter/blob/master/LICENSE.txt).
## 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](https://python-poetry.org)
and Node.js 18.
### Set up
1. Install Python dependencies:
```shell
poetry install
```
2. Install Node.js dependencies:
```shell
npm install
```
### Build a wheel
```shell
poetry run python scripts/build.py
```
### Build the docs
```shell
poetry run python scripts/build_docs.py
```
### Run visual regression tests
Requires [Podman](https://podman.io/getting-started/installation).
```shell
poetry run python scripts/run_e2e_tests.py
```
#### Update changed snapshots
```shell
poetry run python scripts/run_e2e_tests_update_snapshots.py
```