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 Distribution
Hashes for sphinx_bazel-0.1.3-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 203715825504e92117f0e14680fc6ebe9ae3d5584da250e0b418b1836332a3e9 |
|
MD5 | 495e3eeb211bd19b6680407f0dbc2410 |
|
BLAKE2b-256 | 5400b363bd0a0f2f6df450099f146af5704a0e7c4fb96e742d44a7f59a7cdeef |