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.

Source Distribution

sphinx-bazel-0.1.6.tar.gz (11.8 kB view hashes)

Uploaded source

Built Distribution

sphinx_bazel-0.1.6-py3-none-any.whl (18.6 kB view hashes)

Uploaded py3

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page