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在eclipse中查找测试类   sql JAVA如何将数组传递到@NamedNativeQuery   Java通用列表   java JnetPcap:从脱机文件读取非常慢   从java读取Arduino上的LED状态   java NetBeans在安装JAXRPC插件后不会启动   java我只能连接到数据库一次   java如何将Eclipse的自动插入分号移动到光标之前?   java Kotlin Lint测试失败,即使它在生产环境中工作   在java代码中使用python库   安卓 java。lang.IllegalArgumentException:baseUrl必须以/结尾,同时对GET方法使用改型2.1.0   java如何理解servlet中的参数值?   java按子类导入父类包限定符的内部接口   在LibGDX中,在程序运行时更改fixture定义   javajavax。servlet。LocalStrings缺少资源   java如何使用FCM令牌向Android中的特定用户发送通知?   actionscript 3 Flex与Java GWT的集成   java无法解析hibernate。cfg。xml   使用相同的正则表达式时,Python和Java正则表达式的行为不同