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/

欢迎加入QQ群-->: 979659372 Python中文网_新手群

推荐PyPI第三方库


热门话题
java如何在jetty请求日志中添加milliscond字段?   java在使用Scanner类从文件读取信息时遇到问题   为什么。类不适用于泛型类型?   SQLite插入上的java空指针异常   java能告诉我们Guava缓存是在禁用统计数据的情况下构建的吗?   java在应用程序中使用常量   java无法使用AutoIT和Selenium Webdriver在所需位置/文件夹保存图像   java如何在jtable中更新jprogress栏   java是比较给定日期和当前日期(在给定时区中没有时间段)的最佳方法   安卓代码中的java错误   java无法访问实体类中的字段   java如何在tomcat中处理三个JDBC连接池?   java无法使用Spring Security保护AngularJS页面   如何在没有TCP/IP协议栈的情况下用Java发送以太帧