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 details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

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

Uploaded Python 3

File details

Details for the file sphinx-guru-builder-0.1.2.tar.gz.

File metadata

  • Download URL: sphinx-guru-builder-0.1.2.tar.gz
  • Upload date:
  • Size: 4.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.3 CPython/3.7.8 Darwin/20.1.0

File hashes

Hashes for sphinx-guru-builder-0.1.2.tar.gz
Algorithm Hash digest
SHA256 377cb87f214eecbfce02b2290a381f1355a8817d3ab6a3ccc83365531e149a89
MD5 1e1481448d3fff9444027e69ed07d549
BLAKE2b-256 daf6fd35f4aa36cd09eeaa6a01626370f077172095ce1b1c1689d4bff6acb428

See more details on using hashes here.

File details

Details for the file sphinx_guru_builder-0.1.2-py3-none-any.whl.

File metadata

File hashes

Hashes for sphinx_guru_builder-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 db7b70f4b76980122fbc3f20dedc64f636a655720d609e2a10e198ad28b63a64
MD5 8417bacc617e28242fb93f36c80eabe7
BLAKE2b-256 6ca64bed1961dc1b066f5520caddc66063f055e7e6530ae9097f56472f095b5c

See more details on using hashes here.

Supported by

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