Python 程序有啥好的自动从注释生成文档的方法

Posted 2023-04-23

用Sphinx
以win32系统为例，最简单的安装方式是在Dos下输入如下代码
pip install -U sphinx
安装好了之后，用最简单的半自动生成API文档的方式进行
例如：你的python安装在C:\\python27， 想要给flask包自动制作文档，制作完成的文档放在C:\\python_doc\\flask的文件夹
代码如下：
sphinx-apidoc -F -o C:\\python_doc\\flask C:\\python27\\lib\\site-packages\\
（此处-o应紧跟输出文件夹，不然会产生一个-F的文件夹，多谢@Hyacz）
然后进入C:\\python_doc\\flask文件夹
cd C:\\python_doc\\flask
此文件夹下有一个make.bat文件，再执行一下
make html
然后就能在\\_build\\html文件夹中看到生成好的文档了，还支持查找的功能 参考技术A 1对于函数字符串文档：
（1）定义方式：
可以由成对单引号或双引号创建单行字符串文档
或使用成对三元引号'''创建多行字符串文档
（2）输出字符串文档
使用help(函数名)输出函数文档及参数列表
或通过 函数名.__doc__来只输出文档字符串
2对于一般注释，本人暂没有形成规范的方法本回答被提问者采纳

指南针精灵生成器有啥好的替代品吗？ （Rails 精灵生成器）

【中文标题】指南针精灵生成器有啥好的替代品吗？ （Rails 精灵生成器）

【英文标题】：Are there any good alternatives to the Compass sprite generator? (Rails sprite generators)指南针精灵生成器有什么好的替代品吗？ （Rails 精灵生成器）

【发布时间】：2015-06-21 21:42:42

【问题描述】：

我想知道是否有任何库可以完成 Compass 精灵生成器的功能？我非常喜欢 Compass 的这个特性，但我不想要框架的其余部分。我只想创建一个带有一个充满 PNG 的文件夹的精灵，并且可能创建一些 CSS 类，我可以使用这些类在精灵中显示图形。我做了一些探索，我看到很多精灵生成器作为网络应用程序。人们是否将这些用于高流量网站？还是人们通常使用 Photoshop 或其他更好的工具来维护自己的精灵？任何信息都非常感谢！

【问题讨论】：

我必须把这个标记或描述得不好，因为我不敢相信这样的问题没有更多的输入。

【参考方案1】：

回答我自己，是的，有几个选择：

https://github.com/jakesgordon/sprite-factory

https://github.com/aslansky/css-sprite

https://github.com/wellington/wellington