注释，然后通过构建脚本自通生成文档，包括html，latex，pdf等。对应于Pyhon，有很多可供选择的 ...

文档生成工具： 自带的pydoc，比较差 建议使用sphinx 安装： pip install sphinx 安装主题： 由各种主题，我选择常用的sphinx_rtd_theme pip install sphinx_rtd_theme 使用方法： 1、创建文件夹doc ...

安装 使用pip进行安装： pip install sphinx 初始化 进入你代码所在的目录,输入: sphinx-quickstart 下图：PRD是代码所在目录，生成的文档保存目录设成doc 下图：设置项目名称与作者，项目名称之后会作为标题显示在文档首页 下图：基本一路 ...

sphinx简介 sphinx是一种基于Python的文档工具，它可以令人轻松的撰写出清晰且优美的文档，由Georg Brandl在BSD许可证下开发。 新版的Python3文档就是由sphinx生成的，并且它已成为Python项目首选的文档工具，同时它对C/C++项目也有很好的支持。 更多详细 ...

...

Sphinx: 发音： DJ音标发音： [sfiŋks] KK音标发音： [sfɪŋks] 单词本身释义： an ancient imaginary creature with a lion's body and a woman's head Mythology ...

在使用python中，我们一般在模块，类，函数下使用docstring添加字符串说明性文档，使开发人员更好的可以看懂此代码是做什么用的。然而写了那么多的注释，我们想要一篇文档怎么办，第一种办法不可能将写完的注释直接手动的ctrl+c ctrl+v的，此时sphinx就出现了，解决了这一 ...

技术背景 该文章一方面从量子线路的打印着手，介绍了一个简单的python量子线路工程。同时基于这个简单的小工程，我们顺带的介绍了python的API文档自动化生成工具Sphinx的基本使用方法。 量子线路背景知识 在前面几篇博客中，有介绍过使用开源量子计算编程框架ProjectQ进行量子线路 ...