首页
学习
活动
专区
圈层
工具
发布
    • 综合排序
    • 最热优先
    • 最新优先
    时间不限
  • 来自专栏北京马哥教育

    使用 sphinx 制作简洁而又美观的文档

    docs ├── etc ├── ops ├── setup.py └── example 根据py代码生成rst风格文件,这里我只生成ops/api/contrib下面的py文档 # sphinx-apidoc Creating file docs/make.bat. sphinx-apidoc具体用法参考: http://zh-sphinx-doc.readthedocs.org/en/latest/invocation.html

    2.1K60发布于 2018-05-04
  • 来自专栏FreeBuf

    Flashmingo:SWF文件自动化分析工具

    conf.py文件中启用napoleon: 在conf.py中,将napoleon添加到extensions列表中 extensions = ['sphinxcontrib.napoleon'] 使用sphinx-apidoc 构建你的API文档: $ sphinx-apidoc -f -o docs/source projectdir 这将创建.rst文件供Sphinx处理 $ make html *参考来源:GitHub

    1.9K10发布于 2019-05-14
  • 来自专栏Dechin的专栏

    使用python编写量子线路打印的简单项目,并使用Sphinx自动化生成API文档

    这些rst文件没有被自动生成的情况下,可能需要使用sphinx-apidoc去手动的添加: [dechin@dechin-manjaro hiqfermion]$ sphinx-apidoc -f src 还有一点需要注意的是,如果我们直接使用sphinx-apidoc -f src/hiqfermion -o docs/source/这样的指令去生成的话,最终文档中的结构都是hiqfermion.module1 当然,首先我们需要逐一的去执行sphinx-apidoc来生成一些模块化的rst文件:sphinx-apidoc -f src/hiqfermion/module1 -o docs/source/以及sphinx-apidoc

    3.4K20发布于 2021-05-21
  • 来自专栏全栈技术

    Python开发工具大揭秘:提高生产力的秘密武器

    # 代码示例:使用Sphinx生成文档 sphinx-quickstart # 初始化Sphinx项目 sphinx-apidoc -o docs/source mymodule # 生成API文档

    60130编辑于 2023-09-19
  • 来自专栏机器人课程与技术

    Win10/Ubuntu20.04编译ros2_documentation-foxy过程

    WARNING: The scripts sphinx-apidoc, sphinx-autogen, sphinx-build and sphinx-quickstart are installed

    73310发布于 2021-12-02
领券