Skip to main content

Sphinx bazel extension to include content from bazel files.

Project description

Complete, rendered documentation: http://sphinx-bazel.readthedocs.io/en/latest/

Sphinx-Bazel

Sphinx extension to provide information from bazel files to sphinx based documentations.

Installation

pip install sphinx-bazel

Usage

Add sphinxcontrib.sphinx_bazel to the extension list of conf.py:

extensions = [
    'sphinx.ext.autodoc',
    'sphinx.ext.todo',
    'sphinx.ext.viewcode',
    'sphinxcontrib.sphinx_bazel',  # <-- That's our extension
]

Now you can start to use Sphinx-Bazel inside your project.

For instance open index.rst file and add:

.. autobazel-workspace:: <path_to_bazel_workspace>
   :packages:

Where <path_to_bazel_workspace> must be an absolute path or a relative path to the location of the conf.py file of your documentation project.

Fore more examples and a complete documentation, please visit http://sphinx-bazel.readthedocs.io/en/latest/

Project details


Download files

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

Files for sphinx-bazel, version 0.1.1
Filename, size File type Python version Upload date Hashes
Filename, size sphinx_bazel-0.1.1-py2.py3-none-any.whl (12.9 kB) File type Wheel Python version 3.6 Upload date Hashes View hashes
Filename, size sphinx-bazel-0.1.1.tar.gz (9.9 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page