<整理> 使用Python Sphinx自动生成代码文档

来源:https://blog.csdn.net/sinat_29957455/article/details/83657029

           https://www.cnblogs.com/xuzijie/p/9677621.html

侵权请联系本人!

前置步骤:

       1、创建src文件夹,里面存放源码;创建doc文件夹,里面准备存放Sphinx制作文档产生的和需要的文件。

       2、已完成的python代码需要有完整的docstring,docstring采用reStructuredText格式(简要书写方法请参考文末示例代码)。

       3、安装python和pip,使用pip安装sphinx。

生成步骤:

       1、在doc文件夹中执行sphinx-quickstart。

       2、关于sphinx-quickstart的配置页面有以下的说明:

             

111

猜你喜欢

转载自www.cnblogs.com/icemaster/p/10417737.html