1 spinx简介 Sphinx 是一种文档工具,它可以令人轻松的撰写出清晰且优美的文档, 由 Georg Brandl 在BSD 许可证下开发. 新版的Python文档 就是由Sphinx生成的,并且它已成为Python项目首选的文档工具,同时它对 C/C++ 项目也有很好的支持; 并计划对其它开发语言添加特殊支持. 本站当然也是使用 Sphinx 生成的,它采用reStructuredText! Sphinx还在继续开发. 下面列出了其良好特性,这些特性在Python官方文档中均有体现: 丰…

1.下载安装 Sandcastle 程序. http://download-codeplex.sec.s-msft.com/Download/Release?ProjectName=shfb&DownloadId=1408995&FileTime=130655702941330000&Build=21029 2.在程序中使用批注将代码注释说明清楚. 标记 说明 <event> 对某个成员可能引发的事件的说明. <example> “示例”,帮助类库使用者理解…

最近有朋友想在windows下做个人笔记,没有找到顺手的工具,问我有什么好的工具推荐.正好前两天在网上看到一款做文档的利器sphinx+reStructText,当时在ubuntu下搭了下环境试了试,做笔记真的非常方便.今天在windows下试了试,遇到一些问题,但总算成功了,现整理如下. 简介 1  reStructuredText是什么? reStructuredText是扩展名为.rst的纯文本文件,含义为”重新构建的文本“,是python编程语言的Docutils项目的一部分..rst文…

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

0 前言 写文档是开发人员日常工作中的一项重要内容,除了word之外,我更偏爱使用标记语言(Markup Language).使用标记语言,可以利用简单.免费的文本编辑器(记事本,vim, emacs...)编写文档并设置格式,再生成html或pdf等格式,或者直接把编辑好的文件传到github或wiki上面 ,通过浏览器可以直接查看带有格式的文档. 目前标记语言主要有两种,Markdown和reStructuredText(简称reST).该使用哪一种是一个见仁见智的选择,我在这里就不比较它们…

Oracle-在线重定义操作文档 2015年10月8日 15:51 在线重定义的大致操作流程如下: (1)创建基础表A,如果存在,就不需要操作. (2)创建临时的分区表B. (3)开始重定义,将基表A的数据导入临时分区表B. (4)结束重定义,此时在DB的 Name Directory里,已经将2个表进行了交换.即此时基表A成了分区表,我们创建的临时分区表B 成了普通表. 此时我们可以删除我们创建的临时表B.它已经是普通表. 下面看一个示例: 1. 创建基本表和索引 SQL> create ta…

本篇文章中将讲解如何使用MongoDB操作文档. 文档的数据结构和JSON基本一致,所有存储在集合中的数据都是BSON格式.BSON是一种类似json格式的一种二进制形式的存储格式,简称Binary JSON. 一.插入文档 MongoDB使用insert()或save()方法向集合中插入文档,语法如下: db.COLLECTION_NAME.insert(document) 例如:以下文档可以存储在MongoDB的test数据库的MongoDBTest集合中: {"title" :…

python代码测试并自动生成文档 Tips:两大工具:doctest--单元测试.Sphinx--自动生成文档 1.doctest doctest是python自带的一个模块.doctest有两种使用方式:一种是嵌入到python源码中,另外一种是放到一个独立文件. 1.1 嵌入源码 新建test.py import doctest ''' '>>>' 开头的行就是doctest测试用例. 不带 '>>>' 的行就是测试用例的输出. 如果实际运行的结果与期望的结果不一…

在使用Python.Django的过程中,经常看到docs目录,里面存放着一些txt文本文件,也就是自带的一些帮助文档,里面有make.bat,在dos目录下直接执行make,给出的帮助是可以转换成Html.PDF等文件形式,那么,怎么转换这些帮助文档呢?直接执行make html发现提示sphinx-build不是内部或外部命令,在网上下载了Sphinx,并安装,再次执行make html时发现还是提示不是内部或外部命令,最后发现,Sphinx安装后,并没有在Python安装目录中生成Sphi…

cakephp的文档是用一个叫sphinx程序生成的 这个程序是python写的,所以我们要用sphinx本机必须先装python. 编译过程在Ubuntu下进行,默认Ubuntu已经安装了python, 命令行下依次执行 sudo apt-get install python-setuptools sudo apt-get install easy_install easy_install sphinx easy_install sphinxcontrib-phpdomain 最后把cakep…