sphinx python

由于python命令大小写敏感, 查看版本号必须用大写的-V命令

step 1: window环境下用spinx生成html文档

sphinx语法文档规范： https://pythonhosted.org/an_example_pypi_project/sphinx.html

运行：在根目录下$ make html，就可以在build 路径下产生html 文件

新生成html文件：在根目录下创建example.rst，还需要将它列在 toctree 中，但要谨慎操作。文件名后面需要有一个间隔，这样文件名清单才会有效，该文件不需要文件扩展名（在本例中为 .rst）

index.rst 中的 toctree 示例：

Contents:

.. toctree::

:maxdepth: 2

example

在根目录下$ make html，就可以在build 路径下产生example.html 文件。

index.rsf文件详解：

其中，toctree（table of contents）代表文档的目录页，toctree 是sphinx 指令，主要功能是将多个文件链接到一个单一页面中组成层级结构。（说人话：生成文档目录）。maxdepth 代表目录显示的最大层级。

toctree 命令初始化是空的，像下面这样：

.. toctree:::maxdepth: 2

在 source 文件夹中，新建一个叫做 usage 的文件夹，再在 usage 文件夹中新建两个文件，分别命名为 installation.rst、quickstart.rst。

上面的 toctree 指令内容改成如下这样。

.. toctree:::maxdepth: 2usage/installationusage/quickstart

如此，toctree 指令使用文档名称（省略后缀名）作为目录的中的链接地址。使用 /（正斜杠）作为路径分隔符。总之，目录的结构就是按照文件夹中文件的编排来进行布置。需要在目录中链接什么文件，就将该文件之于source路径的相对路径填写在toctree之后就可以。而maxdepth是代表目录中链接的文件的文章层级，比如上述代码中，链接installation.rst文件中的一级标题和二级标题的内容，在目录页面，也就是当前的index.rst页面中显示。

需要注意的是：

形如 usage/installation 作为 toctree指令的内容（content）需要跟在可选项（options）的后面，空一行，才能发挥作用
maxdepth 作为 toctree指令的可选项（options），:maxdepth: 和 2 之间需要空一格，才能生效

sphinx python相关推荐

sphinx python_如何使用Sphinx记录Python代码
sphinx python Python代码可以在其源代码中包含文档. 这样做的默认方式取决于docstrings ,它以三引号格式定义. 尽管文档的价值是有据可查的,但似乎似乎太普遍了,以至于没有足 ...
Python全家福，这些库你认识哪些？
环境管理管理 Python 版本和环境的工具 p – 非常简单的交互式 python 版本管理工具. pyenv – 简单的 Python 版本管理工具. Vex – 可以在虚拟环境中执行命令. v ...
[转载] python常用库
参考链接: Python–新一代语言转载至:https://www.cnblogs.com/jiangchunsheng/p/9275881.html 今天我将介绍20个属于我常用工具的Python ...
Python资源大全屌炸Python库
交互式解析器交互式 Python 解析器. IPython – 功能丰富的工具,非常有效的使用交互式 Python. bpython– 界面丰富的 Python 解析器. ptpython – 高级 ...
python---（2）Python库资源大全
转载地址:https://zhuanlan.zhihu.com/p/27350980 本文是一个精心设计的Python框架.库.软件和资源列表,是一个Awesome XXX系列的资源整理,由BigQu ...
Python 资源库大全
Awesome Python ,这又是一个 Awesome XXX 系列的资源整理,由 vinta 发起和维护.内容包括:Web框架.网络爬虫.网络内容提取.模板引擎.数据库.数据可视化.图片处理.文 ...
awesome python 中文版相见恨晚！(pythonNB的第三方资源库)
Awesome Python中文版来啦! 原文链接:Python 资源大全内容包括:Web框架.网络爬虫.网络内容提取.模板引擎.数据库.数据可视化.图片处理.文本处理.自然语言处理.机器学习.日志 ...
python常用代码大全-Python常用库大全，看看有没有你需要的
环境管理管理 Python 版本和环境的工具 p – 非常简单的交互式 python 版本管理工具. pyenv – 简单的 Python 版本管理工具. Vex – 可以在虚拟环境中执行命令. v ...
[转载] 20个常用Python库及200个第三方库
参考链接: 使用Python在Linux Terminal中格式化文本 Requests.Kenneth Reitz写的最富盛名的http库.每个Python程序员都应该有它 Scrapy 如果你从事 ...

sphinx python

sphinx python相关推荐

最新文章

热门文章