SPHINX 文档写作工具安装简要指南 - windows 版 - 基于python

此教程基于本地己安装好 PYTHON 并配置过全局变量;一定具备相应的基础再操作;

上传图片以免产生误导,以下为文字描述,按下列操作即可:

  1. 下载 get-pip.py脚本;
  2. python get-pip.py -(很多教程,执行这个文件,就直接使用PIP .其实还需要配置PIP的全局变量;如果知道全局PYTHON安装在哪里或是不知道,参考寻找目录为:C:\Users\Administrator\AppData\Local\Programs\Python\Python36-32\Scripts)
  3. pip install sphinx -(这里安装部分会直接安装在当前目录)
  4. 输入sphinx-quickstart
  5. PIP INSTALL __XXX__ -(安装SPHINX 主题
  6. make html
  7. _build\html 文件夹就是生成的html了;
  8. 完成;
  9. SPHINX 手册文档
时间: 2024-10-01 02:50:12

SPHINX 文档写作工具安装简要指南 - windows 版 - 基于python的相关文章

DBImport v3.3 中文版发布:数据库数据互导及文档生成工具(IT人员必备)

前言: 好久没写文了, 距离上一篇文章是3个月前的事了,虽然工作很忙,主要还是缺少写作的内容和激情,所以没怎么动手. 之前有一个来月不断面试不同层次来应聘的人员,很有想写文的冲动,后来还是忍住了. 估计写了也是那种说人坏话.恨铁不成钢的情绪文,没啥营养,所以情绪过了就没想写了. 在公司除了管理上的事情之外,另外也研发了一套适用信息系统的快速开发框架,这个有机会再写写文和大伙分享了. 下面言归正文了. 背景: 关于这个DBImport工具,发布的版本不多,仅有:V1.0.V2.0.V3.0.V3.

.NET平台开源项目速览(4).NET文档生成工具ADB及使用

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

Markdown 文档生成工具

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

GIT+云盘作 做 文档管理工具

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

使用Objective-C的文档生成工具:appledoc

前言 做项目的人多了,就需要文档了.今天开始尝试写一些项目文档.但是就源代码来说,文档最好和源码在一起,这样更新起来更加方便和顺手.象 Java 语言本身就自带 javadoc 命令,可以从源码中抽取文档.今天抽空调研了一下 objective-c 语言的类似工具. 从 stackoverflow 上找到三个比较 popular 的工具:doxygen, headdoc 和 appledoc .它们分别的官方网址如下: docxygen http://www.stack.nl/~dimitri/

(转)Doxygen文档生成工具

http://blog.csdn.net/lostaway/article/details/6446786 Doxygen 是一个支持 C/C++,以及其它多种语言的跨平台文档生成工具.如同 JavaDoc, doxygen 直接从源文件中提取符合 doxygen 注释规范的注释,生成文档[1]. 1.安装 1.1 安装 Doxygen 1.7.4(Windows) 地址:ftp://ftp.stack.nl/pub/users/dimitri/doxygen-1.7.4.windows.bin

微软开源全新的文档生成工具DocFX

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

强烈推荐 在线接口文档管理工具 小幺鸡 小团队可以省掉测试了

在朋友那儿看到一个不错的在线文档管理工具 主要特点 : 在线接口测试 在线测试,方便前后端开发,降低错误率.支持:xml.json.txt.binary.websocket 可视化编辑与分享 可视化编辑器,完善的分享机制,多功能导出.让接口撰写变得十分简单 安全保障 基于阿里云服务器,提供安全备份系统.多家公司使用,安全证明. 代码开源 可离线安装到内网服务器仅供公司内部使用.接口在线测试,降低接口错误率 开放源码,支持任意修改 简洁明了的API 简单的维护更新 多种导出满足不同需求 自己搭建试

使用Objective-C的文档生成工具

前言 做项目的人多了,就需要文档了.今天开始尝试写一些项目文档.但是就源代码来说,文档最好和源码在一起,这样更新起来更加方便和顺手.象Java语言本身就自带javadoc命令,可以从源码中抽取文档.今天抽空调研了一下objective-c语言的类似工具. 从stackoverflow 上找到三个比较popular的工具:doxygen, headdoc和appledoc .它们分别的官方网址如下: docxygen http://www.stack.nl/~dimitri/doxygen/ind