软件应用之 Sphinx

  1. start
  2. conf.py

start

运行sphinx-quickstart,会提示输入一些基本配置,更深入的配置,可通过修改conf.py实现。

conf.py

  • sys.path.insert(0, os.path.abspath('../../'))用于设置源码路径
  • 添加automodule,这里指定的smartlock.py是需要在源码路径下(即可以import smartlock
.. automodule:: smartlock
   :members:
  • extensions添加autodoc,自动提取docstring
  • 设置主题html_theme = 'sphinxdoc'
  • 安装m2r,可以在rst中嵌入markdown文档

转载请注明来源,欢迎对文章中的引用来源进行考证,欢迎指出任何有错误或不够清晰的表达。可以在下面评论区评论,也可以邮件至 [ yehuohan@gmail.com ]

文章标题:软件应用之 Sphinx

本文作者:Y

发布时间:2020-07-16, 13:40:00

最后更新:2020-08-13, 20:24:13

原始链接:http://yehuohan.github.io/2020/07/16/%E6%9D%82%E8%AE%B0/0Usage/%E8%BD%AF%E4%BB%B6%E5%BA%94%E7%94%A8%E4%B9%8B-Sphinx/

版权声明: "署名-非商用-相同方式共享 4.0" 转载请保留原文链接及作者。