Skip to main content

Sphinx Builder for Guru

Project description

sphinx-guru-builder

Installation

$ pip install sphinx-guru-builder

Usage

  1. Add the extension to your conf.py.
extensions = [
    "sphinx_guru_builder",
]
  1. Optionally, add html_published_location to create a link on each page to the original docs.
html_published_location = "https://example.com/docs"`
  1. Build your docs.
$ sphinx-build -b guru source_dir build_dir
  1. Upload the generated guru.zip file in the parent directory of the build_dir.

See Guru API docs for instruction on how to upload the archive.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

sphinx-guru-builder-0.1.2.tar.gz (4.1 kB view hashes)

Uploaded Source

Built Distribution

sphinx_guru_builder-0.1.2-py3-none-any.whl (4.5 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page