ApiDoc 1.4.0

小结

ApiDoc是为使用python构建的api设计的文档生成器，由SFR Business Team给出。

• 演示：http://solutionscloud.github.io/apidoc/demo
• 主页：http://solutionscloud.github.io/apidoc
• 文档：http://apidoc.rtfd.org
• 错误跟踪器：https://github.com/SolutionsCloud/apidoc/issues
• github:https://github.com/SolutionsCloud/apidoc
• PYPI:https://preview-pypi.python.org/project/ApiDoc
• 许可证：gplv3+

安装

最快的入门方法是使用命令行工具

$ sudo apt-get install python3-pip
$ pip3 install apidoc

如果包Python 3PIP不存在

$ sudo apt-get install python3-setuptools
$ sudo easy_install3 pip
$ sudo pip3-2 install apidoc

试试看

您可以下载一个示例文件并尝试将其呈现为文档

$ mkdir apidoc
$cd apidoc
$ wget https://raw.github.com/SolutionsCloud/apidoc/master/example/demo/source.yml
$ apidoc -i source.yml -o output/index.html
$ firefox output/index.html

1.3（2016-05-08）

• 小修补程序

1.2（2014-01-22）

• Feature #17合并apidoc的二进制文件
• Feature #18将cli参数-f和-d合并到一个参数-i（输入）
• Feature #21在对象中添加patternproperties和additionalproperties
• Feature #22“properties”和“items”是可选的
• Feature #23属性“type”是可选的
• Bug #26搜索框错误地隐藏了一些元素
• Bug #27搜索筛选项差异的快捷键
• Feature #32增强了readthedocs的主题

1.1（2013-08-28）

• Feature #6减小资源大小
• Feature #8小型设备上的diffmode
• Feature #9链接到顶部
• Bug #10关键字optional override cod
• Feature #11改进检测到的类型
• Feature #12在属性上添加规则
• Feature #13添加修补程序和选项方法
• Feature #14用引导模式替换快捷方式popin
• Feature #16升级到bootstrap 3
• Bug #19在采样对象中添加约束
• Bug #31版本1.1中的错误“templatenotfound:default.html”

1.0（2013-07-23）

• 初始版本