$ pip install sphinx-guru-builder
- 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.