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
Built Distributions
Hashes for sphinx_bazel-0.1.5-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 11c46974445eb47eb5487cb364a1bd377a708111cc247a9e01112671de91d979 |
|
MD5 | 0eae8c8a4acc4f2c63075390e271aeac |
|
BLAKE2b-256 | ef950a75f1ffa7b92b47f98fbe94d25fb2365b9f9084a01b3f14b14519a5a642 |
Hashes for sphinx_bazel-0.1.5-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 64087d58cf6f406fdc4bac7c12d07b13743301be1ffe5a9aa47b4d3aa4250c5b |
|
MD5 | 81d0ab9cf7585e007faf983e07893dd3 |
|
BLAKE2b-256 | b6195510c64c852d77a02baaceec17607f712d978c84607da645e525c006c4e3 |