Sphinx Bazel扩展名,包含来自Bazel文件的内容。
sphinx-bazel的Python项目详细描述
完成,呈现文档:http://sphinx-bazel.readthedocs.io/en/latest/
狮身人面像火箭筒
Sphinx扩展,提供从Bazel文件到基于Sphinx的文档的信息。
安装
pip install sphinx-bazel
使用量
将sphinxcontrib.sphinx_bazel添加到conf.py:的扩展列表中
extensions = [ 'sphinx.ext.autodoc', 'sphinx.ext.todo', 'sphinx.ext.viewcode', 'sphinxcontrib.sphinx_bazel', # <-- That's our extension ]
现在您可以开始在项目中使用Sphinx-Bazel。
例如,打开index.rst文件并添加:
.. autobazel-workspace:: <path_to_bazel_workspace> :packages:
其中<path_to_bazel_workspace>必须是指向conf.py文件位置的绝对路径或相对路径 你的文档项目。
有关更多示例和完整文档,请访问http://sphinx-bazel.readthedocs.io/en/latest/