logo
  • 教程列表
  • SO官方文档
  • 使用 autodoc 编写文档字符串
    • 安装 autodoc 扩展
    • 在 sphinx 配置中添加代码路径
  1. StackOverflow 文档
  2. python-sphinx 教程
  3. 使用 autodoc 编写文档字符串
  4. 安装 autodoc 扩展

安装 autodoc 扩展

Created: November-22, 2018

在文档根目录的 conf.py 文件中的 extensions list 中添加 autodoc 模块:

extensions = [
    'sphinx.ext.autodoc',
     ...
]
  • 在 sphinx 配置中添加代码路径
  • 使用 autodoc 编写文档字符串

Copyright © 2018. All right reserved

tastones.com 备案号:鲁ICP备18045372号-1

  • 关于我们
  • 免责声明