https://github.com/scality/sphinx-tools
Scality theme and other tools for Sphinx documentation
https://github.com/scality/sphinx-tools
Last synced: 14 days ago
JSON representation
Scality theme and other tools for Sphinx documentation
- Host: GitHub
- URL: https://github.com/scality/sphinx-tools
- Owner: scality
- License: apache-2.0
- Created: 2019-07-17T10:05:01.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2025-10-03T07:41:40.000Z (9 months ago)
- Last Synced: 2025-10-03T09:26:44.650Z (9 months ago)
- Language: JavaScript
- Homepage:
- Size: 3.71 MB
- Stars: 1
- Watchers: 42
- Forks: 0
- Open Issues: 18
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Scality theme for Sphinx documentation
To test this theme, you will need:
- `make`
- `tox`, with Python 3
To build the example docs provided in this repository, using the local
definition of the `scaldoc` package, simply run:
```
tox -e docs
```
The built HTML will be in `example/_build`.
If you need extra dependencies to install, first edit the
`example/requirements.in` file, then run `tox -e pip-compile` before
re-building with `tox -e docs`.