Sphinx - 帮助文档制作工具

此教程基于本地己安装好 PYTHON 并配置过全局变量:一定具备相应的基础再操作: 上传图片以免产生误导,以下为文字描述,按下列操作即可: 下载 get-pip.py脚本; python get-pip.py -(很多教程,执行这个文件,就直接使用PIP .其实还需要配置PIP的全局变量:如果知道全局PYTHON安装在哪里或是不知道,参考寻找目录为:C:\Users\Administrator\AppData\Local\Programs\Python\Python36-32\Scripts)

1.Sphinx简介和使用理由 ========= Sphinx是一个用Python语言编写而成的文档编写工具.用Sphinx编写文档的时候,用户只需要编写符合Sphinx格式要求的纯文本源文件,然后通过Sphinx的命令就可以把纯文本源文件编译成html.pdf等常用格式的文档,这样就实现了通过文本文件自动生成html.pdf等格式文档的功能. 编写文档直接用Word不就是挺好的吗?为什么又要用Sphinx来写纯文本格式的文档呢? 这是因为Sphinx中的文本格式文档可以用版本控制系统跟踪它的

一,准备工作 1,首先介绍一款VS的代码注释插件GhostDoc 你也许认为我们在代码中敲入///就能自动生成xml注释,但这种注释是没有说明文字的.而GhostDoc可以生成一些简单的说明文字,如果你的函数命名很规范的话,它生成的函数描述会很准确.并且它还能生成一些参数类型的附加说明.在你想生成代码注释的地方按下Ctrl+Shift+D,它就会自动帮你生成xml注释,非常方便.下载地址:http://submain.com/products/ghostdoc.aspx GhostDoc毕竟是个

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

大家好,我是成都ld,最近学习了下python和Django.我使用的是pydev+eclipse的组合进行的开发,当然,刚开始学习,由于python的方法返回值是没有标明的,所以开发变得有些蛋疼,不得不去查看方法的源码,不知道其他朋友是如何干的~~ 言归正传,今天主要介绍Django文档制作,网上说了很多方法,其实我也只是摸着石头过河,完全自己琢磨,走一步看一步,也不知道对不对,文档做出来了,暂时就这样吧~~. 第一步:首先我下载的是django的1.6.5的版本,django的目录里面有个d

转载自  http://www.cnblogs.com/asxinyu/p/dotnet_Opensource_project_ADB_CSharpDocument.html 阅读目录 1.ADB介绍 2.ADB生成.NET文档过程 3.资源与代码 很久以前就使用ADB这个工具来生成项目的帮助文档.功能强大,在学习一些开源项目的过程中,官方没有提供CHM帮助文档,所以为了快速的了解项目结构和注释.就生成文档来自己看,非常好用.这也是一个学习方法吧.例如本文在: .NET平台开源项目速览(2)Co

程序中的help文档制作 所用工具:HTML Help Workshop 文件包括:各个html文档,帮助页面的具体内容 hhc文档:help的目录文件 hhk文档:help的索引文件 MAP文件夹中放 图片文件 hhp文件打开可以进行编辑

之前用了很多Markdown 文档生成工具,发现有几个挺好用的,现在整理出来,方便大家快速学习. loppo: 非常简单的静态站点生成器 idoc:简单的文档生成工具 gitbook:大名鼎鼎的文档协作工具 docsify:一个神奇的文档站点生成器,简单轻巧,无需静态构建html 教程版: http://me.52fhy.com/learn-markdown-generate-tool/#/ loppo 官网: https://github.com/ruanyf/loppo 依赖 node.js

GIT+云盘作 做 文档管理工具 在工作中, 会遇到公司的文档 和 自己家里的 文档进行同步的问题, 通常我们使用U盘作为传输节制, 但是不是非常好,文档的改动都不能发现, 导致回家同步的时候, 出各种问题. 这时候我们 就可以 考虑使用GIT了,  外加一个百度云盘 则就顺利的完成了 文档同步和历史文档管理 1.  下载必要的工具msysgit+git tortoise + 百度同步盘. 2.  安装三个工具, 并且在初次使用git tortoise 的时候需要指向msysgit的bin目录