Sphinx Builder for Guru
Project description
sphinx-guru-builder
Installation
$ pip install sphinx-guru-builder
Usage
- Add the extension to your
conf.py
.
extensions = [
"sphinx_guru_builder",
]
- Optionally, add
html_published_location
to create a link on each page to the original docs.
html_published_location = "https://example.com/docs"`
- Build your docs.
$ sphinx-build -b guru source_dir build_dir
- Upload the generated
guru.zip
file in the parent directory of thebuild_dir
.
See Guru API docs for instruction on how to upload the archive.
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
Close
Hashes for sphinx-guru-builder-0.1.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9e9bf64665956de98ed013924c9c8ab97438ff066bf3e43b91e02999fb0dc7db |
|
MD5 | fc466a1ff425bb2545f4e5edf0de6f34 |
|
BLAKE2b-256 | d4b4a7f8ae293bee84d65ca8e2830d163e287cf2ece5eec44c20fc4a01de956d |
Close
Hashes for sphinx_guru_builder-0.1.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 489874270cc1eab4ec6214223f3a8aae1ae6903075c36c0fb8e0cf7e0a6b8bb6 |
|
MD5 | c4e2428f4b604f3b5dffa2f6cee3e3af |
|
BLAKE2b-256 | 6c896d167d7676aab5374438037b9870a3b0bbf63d4bfcee68c511f5df42e0b4 |