Navigation index modules | Sphinx主页 | 文档 » 下载 目前版本: 1.2 获得 Sphinx 从 Python Package Index, 或者使用如下命令安装: easy_install -U Sphinx 最新的 开发版本文档 也是可用的. 问题? 建议? 请加入 Google group: 或者加入在FreeNode上的频道#pocoo. 你可以新建或者加入 话题. Quick search Enter search terms or a modul…

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

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

## sphinx 生成开发文档#### 配置 1. 运行如下命令,即可生成 conf.py index.rst Makefile 三个文件: `sphinx-quickstart` 2. conf.py 负责全局配置: 1. 注意一定要启用 `autodoc` 2. `autodoc` 对应配置在: `extensions = ['sphinx.ext.autodoc', 'sphinx.ext.todo', 'sphinx.ext.viewcode'] ` 3. 配置 path 以供sphi…

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

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

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

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

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

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