Giter Club home page Giter Club logo

sphinx-guru-builder's Introduction

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.

sphinx-guru-builder's People

Contributors

j-martin avatar

Stargazers

Maciej Bukczynski avatar McClain Thiel avatar

Watchers

James Cloos avatar Maciej Bukczynski avatar  avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.