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-bazelUsage
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/
Release files for sphinx-bazel 0.1.6
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| sphinx-bazel-0.1.6.tar.gz | 11.8 kB | Without provenance | Details for sphinx-bazel-0.1.6.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| sphinx_bazel-0.1.6-py3-none-any.whl | Python 3 | none | any | Details for sphinx_bazel-0.1.6-py3-none-any.whl |
Total release size: 30.4 kB
Release files / sphinx-bazel-0.1.6.tar.gz
| Download URL | sphinx-bazel-0.1.6.tar.gz |
|---|---|
| Size | 11.8 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
c190dec575dbef685b00570811b2d84bdb79b00c15b145c72425376d8a8d5fa4
|
|
BLAKE2b-256 checksum How to use checksums |
170f319c98f1157e6fe1581b4a56d5e50524ca7a9fb3477e3d2f1cd8873e5632
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.45.0 CPython/3.8.2
|
Release files / sphinx_bazel-0.1.6-py3-none-any.whl
| Download URL | sphinx_bazel-0.1.6-py3-none-any.whl |
|---|---|
| Size | 18.6 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
deb54c9cd164d97e4c900770538fceef4f813384a17b155c86a818174ff368da
|
|
BLAKE2b-256 checksum How to use checksums |
6e59878f5586ad7d150ac55461157b3efd74940557cf0b83ca6698edc6f5e435
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.45.0 CPython/3.8.2
|
Security for sphinx-bazel 0.1.6
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
