sphinx 在python 语言开发中,是一个使用的比较多文档生成脚手架工具,我们帮助我们生成 专业的帮助文档,同时也有远端的免费saas 托管服务,方便分发 安装 sphinx 的安装好多方便,mac 的可以使用brew,或者我们可以使用pip 安装,详细的可以参考官方文档 mac brew 安装方法   brew install sphinx-doc pip 安装 pip install -U sphinx 简单demo sphinx 提供了一个快速生成文档的命令,使用sphinx-qui…

准备软件: 福昕PDF阅读器 下载地址:http://rj.baidu.com/soft/detail/12882.html?ald 安装福昕PDF阅读器,会自动安装pdf打印机. 准备好设置好各级标题的doc文档. 然后在doc文档上鼠标右键--在福昕阅读器中转换成PDF. 等一会儿就自动生成带目录的pdf文档,并在福昕阅读器中打开了. 点保存按钮保存pdf文档即可…

初衷 记得以前写接口,写完后会整理一份API接口文档,而文档的格式如果没有具体要求的话,最终展示的文档则完全决定于开发者的心情.也许多点,也许少点.甚至,接口总是需要适应新需求的,修改了,增加了,这份文档维护起来就很困难了.于是发现了swagger,自动生成文档的工具. swagger介绍 首先,官网这样写的: Swagger – The World's Most Popular Framework for APIs. 因为自强所以自信.swagger官方更新很给力,各种版本的更新都有.swag…

readthedocs 是由社区驱动的开源sphinx doc 托管服务,我们可以用来方便的构建以及发布文档 这是一个简单的demo 项目,使用了用的比较多的sphinx_rtd_theme 主题,主要是试用 注册账户 sphinx 文档需要让readthedocs 托管,我们需要一个账户,注册地址 https://readthedocs.org/ ,注册很简单,我们同时需要进行邮件验证 简单demo 项目 我们可以使用sphinx-quickstart 帮助我们生成简单的测试doc sphin…

初衷 记得以前写接口,写完后会整理一份API接口文档,而文档的格式如果没有具体要求的话,最终展示的文档则完全决定于开发者的心情.也许多点,也许少点.甚至,接口总是需要适应新需求的,修改了,增加了,这份文档维护起来就很困难了.于是发现了swagger,自动生成文档的工具. swagger介绍 首先,官网这样写的: Swagger – The World's Most Popular Framework for APIs. 因为自强所以自信.swagger官方更新很给力,各种版本的更新都有.swag…

首先,打开IDEA,并找到Tools -> Generate JavaDoc- 可供查询的chm比那些HTML页面好看多了. 如果您用过JDK API的chm文档,那么您一定不会拒绝接受其它第三方API的chm文档,比起普通的javadoc网页,chm更无疑更合适用作手册. 可是虽然将html转换成chm的软件多不胜举,却没有合适的软件可以将javadoc转换成像JDK API那种模式.JDK的chm文档可以层叠展开到类和方法,能相当漂亮提供这个功能的我只找到了JavadocToCHM. Jav…

先上图来一波 本身JDK自带了doc文档生成工具,但是不支持排除类,方法,属性,虽然有个@deprecated可以使用,但是达不到我想要的结果(类会被标记为废弃类,编译使用时会提示), 而且类说明示例代码不支持高亮,排版也不行,搜索万能的网友的答案,发现没找到合适的,,,然后就开始漫长的实现.虽然有些地方不完善,没有完全按照官方的全部实现. 1.实现的功能 几十种代码高亮的样式,结合自开源的js. @exclude排除生成类.方法.属性 @link高亮提示 自定义布局比例 以及一些简单注解@ve…

本文地址 http://www.cnblogs.com/likeli/p/8204054.html 关于 API文档自动生成,用于对APP端的开发帮助文档生成,默认ProtoBuffer传输格式. 本项目并不是RESTful风格,是面向功能的API类型.ApiDoc的作用是根据定义好的API接口和注释来自动生成给内部开发者提供的API对接文档. 欢迎Star一下,后续还会更新配套的SDK自动生成,基于Consul的服务注册与发现等,当然,由于我本人能力有限,菜的很,所以这个工具若是对您有用,并且…

文档生成工具: 自带的pydoc,比较差 建议使用sphinx 安装: pip install sphinx 安装主题: 由各种主题,我选择常用的sphinx_rtd_theme pip install sphinx_rtd_theme 使用方法: 1.创建文件夹doc:mkdir doc:cd doc:执行sphinx-quickstart,进入引导,根据需要选择yes或者no 2.执行sphinx-quickstart引导程序只会生成一个index.rst 3.在doc目录下执行sphinx…

微软放弃Sandcastle有些年头了,微软最近开源了全新的文档生成工具DocFX,目前支持C#和VB,类似JSDoc或Sphinx,可以从源代码中提取注释生成文档之外,而且还有语法支持你加入其他的文件链接到API添加额外的说明,DocFX会扫描你的源代码和附加的文件为你生成一个完整的HTML模版网站,你可以自己通过模版定制,目前已经内嵌了几个模版,包括静态的HTML页面和AngularJS页面.你还可以自己定制模版,具体参考 how to create custom template. 源代码…