使用 sphinx 制作简洁而又美观的文档 使用 sphinx 制作简洁而又美观的文档…

参考资料: http://zh-sphinx-doc.readthedocs.io/en/latest/tutorial.html http://avnpc.com/pages/writing-best-documentation-by-sphinx-github-readthedocs http://www.ibm.com/developerworks/cn/opensource/os-sphinx-documentation/ http://blog.csdn.net/xubeiqianni…

先上效果图 详情 首先,须要知道什么是restructuredtext.能够理解为类似于markdown的一个东西. 然后 安装.pip install sphinx 进入存放文档的文件夹,在命令行,sphinx-quickstart,依据须要一路回车.会生成一堆东西,包含conf.py和make等 依据须要改动conf.py 编写rst文件.比方默认的index.rst或链接的rst文件. 在命令行,make html 上图的效果,是使用了一个主题叫sphinx_bootstrap_theme…

Github博文地址,此处更新可能不是很及时. 1.背景 最近发现算法以及数据结构落下了不少(其实还是大学没怎么好好学,囧rz),考虑到最近的项目结构越来越复杂了,用它来练练思路,就打算复习下数据结构与算法.结合最近在学英语,然后干脆就用英文喽.然后选定一本参考书籍<Data Structures and Algorithms in Java>.刚开始看还是蛮吃力的,慢慢来.由于之前有翻录书籍附录的习惯,于是就去书籍附带的官网看了下,发现http://ww0.java4.datastructu…

http://jingyan.baidu.com/article/d8072ac446eb7bec95cefd0e.html 怎么制作CHM格式电子书 http://jingyan.baidu.com/article/aa6a2c143117530d4d19c45e.html 初学者的福音-全面介绍Visual_CHM电子书制作软件 http://www.360doc.com/content/12/0308/14/1113782_192730241.shtml CHM电子书制作软件(CHM-So…

Python, 是一种面向对象.直译式计算机程序设计语言.Python语法简捷而清晰,具有丰富和强大的类库.它常被昵称为胶水语言,它能够很轻松的把用其他语言制作的各种模块(尤其是C/C++)轻松地联结在一起.常见的一种应用情形是,使用python快速生成程序的原型(有时甚至是程序的最终界面),然后对其中有特别要求的部分,用更合适的语言改写,比如3D游戏中的图形渲染模块,速度要求非常高,就可以用C++重写.本文档适合Python爱好者以及用Python语言进行系统管理. GUI开发.Web开发.数…

''' 时间: 9月5日 - 9月30日 要求: 1. 书本内容总结归纳,整理在博客园笔记上传 2. 完成所有课后习题 注:“#” 后加的是备注内容 (每天看42页内容,可以保证月底看完此书) “重点笔记”“本章习题” - 标题1,二级标题用- 标题2,笔记大纲标题.习题题目- 加粗,16px ''' 本章习题: 1. 在什么时候应该使用文档字符串而不是#字注释? 答: 文档字符串被认为最适用于较大.功能性的文档,用来描述程序中的模块.函数.类,以及方法的使用. 2. 举出3种查看文档字符串的方…

常用模块(四) 八.configparser 模块 官方介绍:A configuration file consists of sections, lead by a "[section]" header,and followed by "name: value" entries, with continuations and such in the style of RFC 822. ConfigParse 模块在 python3 中修改为 configparse…

技术背景 该文章一方面从量子线路的打印着手,介绍了一个简单的python量子线路工程.同时基于这个简单的小工程,我们顺带的介绍了python的API文档自动化生成工具Sphinx的基本使用方法. 量子线路背景知识 在前面几篇博客中,有介绍过使用开源量子计算编程框架ProjectQ进行量子线路的绘制,会给我们输出一个tex格式的线路图,在文章中可以直接使用.关于量子线路与量子逻辑门操作,在这篇博客中有比较初步的介绍.而本文章中所创建的工程,是直接在cmd窗口里面打印输出字符串形式的量子线路,同样的…

写好了代码,交付给他人使用的时候,查看代码固然可以了解各类和函数的功能细节,但接口文档能更方便的查找和说明功能.所以,一价与代码同步的接口文档是很有必要的.sphinx可以根据python中的注释,自动的生成接口文档,这样有利于保证文档和代码功能的同步.让我们来了解如何自动生成文档. 1. python代码格式. class A: ''' 你好! ''' @staticmethod def Aa(): ''' 你也好! ''' fun1() 看到类和函数中,都加入了注释. 2. 安装shpinx…

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

书接上一回,小白和老菜聊到代码的版本控制和接口文档 小白:为什么要做版本控制,我不弄版本控制不也完成了项目了吗?要做版本控制不是很麻烦,又要安装服务又要提交代码,代码又不是多人用开发,还要写文档...... 老菜:这就是你这些小白的思维,只看眼前不思长远.对于任何一个项目,你都不可能绝对的说它永远都是一个小项目:而项目完成后,同时也面临着不停的变更与修改,你不可能永远记得这个项目任何细节,随着时间的流逝,很多关键点与细节在你的记忆中就会变得越来越模糊,到时要重新修改时你就头大了.我之前有位同事,…

对搜索引擎.文件索引.文档转换.数据检索.站点备份或迁移等应用程序来说,经常用到对网页(即HTML文件)的解析处理.事实上,通过 Python语言提供的各种模块,我们无需借助Web服务器或者Web浏览器就能够解析和处理HTML文档.本文上篇中,我们介绍了一个可以帮助简化打开 位于本地和Web上的HTML文档的Python模块.在本文中,我们将论述如何使用Python模块来迅速解析在HTML文件中的数据,从而处理特定的 内容,如链接.图像和Cookie等.同时还会介绍如何规范HTML文件的格式标签…

问题:如何查看某个类的方法文档说明或者是函数的参数列表情况? 答: 方法一:直接在需要查询的方法后面加上".__doc__"即可以打印出该方法的文档说明(需要先导入该方法所属模块) 如: 方法二:在windows的命令行模式下还可以输入:"python -m pydoc 方法名"获取该方法的文档说明 如: 方法三:在ipython的命令行解释器模式下可以通过方法名+问号的方式来查看该方法的文档说明(需要先导入该方法所属模块)      如: 方法四:通过help函数…

最近生成训练数据时,给一批无效的背景图片生成对应的xml文档,我用python写了一个简单的批量生成xml文档的demo,遇见了意外的小问题,记录一下. 报错问题为:ImportError: No module named 'xml.dom'; 'xml' is not a package 看见No module named “xxx”时想的是不就是没安装xml包嘛,还不简单,install一下不就好了,然而并没什么用,xml是python本生就带的.其实出现这种错误的原因是自己的命名规则问题,…

关于如何利用Pocket CHM Pro制作帮助文档 编写人:CC阿爸 2015-4-6 今天在这里,我想与大家一起分享如何利用Pocket CHM Pro制作软件系统的帮助文档,在此做个小结,以供参考.有兴趣的同学,可以一同探讨与学习一下,否则就略过吧.   1. 首先给大家看看我制作好后的帮助文档.   如何还算漂亮吧.很多代码在里面,很方便查阅. 2. 下面我们就看看如何利用这个工具制作自己满意的帮助文档 1)         首先大家可以在我们的技术群中,找到该软件. 2)       …

目录 1. 原理 2. 运行方法 3. 效果 4. 代码 1. 原理 正则匹配对相应字符串进行替换 2. 运行方法 python md_convert.py [a.md, b.md,...] # 转换给定文档 或 python md_convert.py # 转换目录下所有的md文档 3. 效果 4. 代码 #coding:utf-8 """ ---------------------------------------- description: md文档格式化处理类 为m…

安装完python第三方库以后,经常需要查询其文档,其实python就自带文档查看器.可以查看所有内置库和第三方库的文档,虽然不是很详尽,但是总比没有的好. 在命令行窗口 python -m pydoc -p 6000 简单解释一下: python -m pydoc表示打开pydoc模块,pydoc是查看python文档的首选工具: -p 6000表示在6000端口上启动server 然后在浏览器中访问http://localhost:6000/…

sphinx简介sphinx是一种基于Python的文档工具,它可以令人轻松的撰写出清晰且优美的文档,由Georg Brandl在BSD许可证下开发.新版的Python3文档就是由sphinx生成的,并且它已成为Python项目首选的文档工具,同时它对C/C++项目也有很好的支持.更多详细特性请参考spinx官方文档,本篇博客主要介绍如何快速为你的Python注释生成API文档. 环境需要安装python安装sphinxpip install sphinx1实例新建一个项目 目录结构如上图所示,…

sphinx简介 sphinx是一种基于Python的文档工具,它可以令人轻松的撰写出清晰且优美的文档,由Georg Brandl在BSD许可证下开发. 新版的Python3文档就是由sphinx生成的,并且它已成为Python项目首选的文档工具,同时它对C/C++项目也有很好的支持. 更多详细特性请参考spinx官方文档 sphinx安装 需要安装python pip install sphinx 示例 新建一个项目 目录结构如下, doc目录使用来存放API文档, src目录是用来存放项目的…

sphinx可以根据python的注释生成可以查找的api文档,简单记录了下步骤 1:安装 pip install -U Sphinx 2:在需要生成文档的.py文件目录下执行sphinx-apidoc -F -o ./doc ./domain/model/ 在当前目录下新建doc目录,api文档的文件夹就在此目录下,./domain/model/ 表示需要生成api文档的目录. 3:进入doc目录 修改conf.py文件 设置代码路径为sys.path.insert(0, os.path.ab…

此sphinx可不是彼sphinx,此篇是指生成文档的工具,是python下最流行的文档生成工具,python官方文档即是它生成,官方网站是http://www.sphinx-doc.org,这里是一个中文翻译站:https://zh-sphinx-doc.readthedocs.io readthedocs.org(下文简称rtd)是一个基于sphinx.mkdocs的在线文档托管网站,支持git.subversion等版本控制系统,并提供多版本.翻译.下载文档等,颇受欢迎. 此篇文章记录了本…

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

第一步:安装Sphinx 首先我们需要安装Sphinx,如果已经安装了Anaconda,那么只需要使用如下命令即可安装,关于其中的参数 -c anaconda,可以在链接[1]中查看: conda install -c anaconda sphinx 也可以使用pip安装: pip install sphinx 安装成功后,新建一个空文件夹,从命令行进入此文件夹,输入如下命令启动sphinx: sphinx-quickstart 之后根据提示一步步操作(碰到yes or no时都选择yes).…

文档生成工具: 自带的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…

一  简单介绍 不管是开源还是闭源,文档都是很重要的.当然理论上说,最好的文档就是代码本身,但是要让所有人都能读懂你的代码这太难了.所以我们要写文档.大部分情况,我们不希望维护一份代码再加上一份文档,这样做很容易造成文档和代码的不一致,程序员最讨厌更新文档了.所以最佳实践就是在程序员代码中加注释,然后通过构建脚本自通生成文档,包括html,latex,pdf等. 对应于Pyhon,有很多可供选择的工具: sphinx中文版介绍 Sphinx使用 reStructuredText作为标记语言(类似…

Sphinx: 发音: DJ音标发音: [sfiŋks] KK音标发音: [sfɪŋks] 单词本身释义: an ancient imaginary creature with a lion's body and a woman's head Mythology A figure in Egyptian myth having the body of a lion and the head of a man, ram, or hawk. [古埃及神话] 斯芬克斯:古代埃及神话中人面.公羊头或鹰头…

简介 Sphinx 是一个 文档生成器 ,您也可以把它看成一种工具,它可以将一组纯文本源文件转换成各种输出格式,并且自动生成交叉引用.索引等.也就是说,如果您的目录包含一堆 reStructuredText 或 Markdown 文档,那么 Sphinx 就能生成一系列HTML文件,PDF文件(通过LaTeX),手册页等. 安装 pip install sphinx 查看是否安装成功 sphinx-build --version 显示对应的版本号即代表安装成功 sphinx-build 5.0.…

这里是总结了一下,用的工具或者平台:readthedocs.github .sphinx. 使用这三个工具即可轻松创建高效的文档管理库,可以用来翻译,水平再高一点可以写书. readthedocs 文档托管的平台,能够和常用的GIT阵营的github,HG阵营的Bitbucket,关于这两个平台的讨论比较文章可以参考. github 代码托管 sphinx 文档书写利器,使用的是reStructuredText格式,reStructuredText简明教程. 下面说说书写方法及托管流程 在这里注…

关于制作文档和笔记这种事,我已经纠结了很久,网上解决方案也一大推,我试过几样,ScrapBook 和 Zotero,编辑不太方便,同步麻烦.Google Note 过于格式简单,现在也不更新了,Google Docs又有点杀鸡用牛刀.还有传得很神奇的 Evernote 跟 Onenote,我压根没兴趣去用. 因为我的笔记大多都是自己写出来,整理出来的,就是精简成自己能看得懂的几段文字而已.我的要求无非这几样:主要是纯文本.工具开源.能同步和备份. 选择纯文本保存,我需要一个预定义格式,让笔记看起…