Sphinx index.rst

假设我们有两个文本file1.rst和file2.rst他们的内容如下
file1.rst

file1 title1
============
这里是段落内容file1 title1.1
--------------
这里是内容file1 title1.2
--------------
这里是内容

file2.rst

file2 title1
=============
这里是段落内容file2 title1.1
--------------
这里是内容file2 title1.1
--------------
这里是内容

下面是index.rst内容

.. toctree:::maxdepth: 2 # 2表示在索引中添加各个文件的2级标题:numbered: # 如果有多个章节则可以进行编号intro # 添加文件，不需要写后缀

:maxdepth: 1

:maxdepth: 2

:numbered:

参考文献：
http://zh-sphinx-doc.readthedocs.io/en/latest/markup/toctree.html

Sphinx index.rst相关推荐

python文档生成工具 sphinx 简介
目录简介 sphinx-build用法 Makefile选项调用sphinx-apidoc 原文出处简介 Sphinx是一个工具,她能够轻易地创建智慧和优雅的文档,她是出自Georg Brand ...
做一个像Keras在线技术文档（Sphinx + GitHub + Read the Docs）
之前看到Keras的中文文档十分心动也想自己做一个,最终被我做成了.这里写一下制作流程. 制作效果感觉还是不错的链接:https://opencv-learning.readthedocs.io/z ...
python如何读取公共盘的文档_如何使用 Sphinx 给 Python 代码写文档 | Linux 中国
最好将文档作为开发过程的一部分.Sphinx 加上 Tox,让文档可以轻松书写,并且外观漂亮.-- Moshe Zadka Python 代码可以在源码中包含文档.这种方式默认依靠 docstring ...
Sphinx+gitee+Read the Docs搭建在线文档系统
本文介绍一种在线文档系统的搭建,需要借助Sphinx.gitee和Read the Docs. Sphinx是一个功能强大的文档生成器,具有许多用于编写技术文档的强大功能 gitee是一种版本管理系统 ...
使用 Sphinx 撰写技术文档并生成 PDF 总结
这几天准备编排部分翻译的书籍和文档,找了好些工具,最终定格在 Sphinx 上,并基于 ReadTheDocs 提供的 SaaS 服务进行分发和分享.本篇博客是对整个过程的一次记录和总结. 项目代码: ...
Python Sphinx使用踩坑记录
描述使用 pip 安装sphinx后,按照教程建立了一个新的py文件,如下 # run.py def run(name):"""this is how we run:p ...
python代码_如何使用 Sphinx 给 Python 代码写文档
最好将文档作为开发过程的一部分.Sphinx 加上 Tox,让文档可以轻松书写,并且外观漂亮.-- Moshe Zadka(作者) Python 代码可以在源码中包含文档.这种方式默认依靠 docst ...
Windows下配置sphinx+reStructuredText详解
最近有朋友想在windows下做个人笔记,没有找到顺手的工具,问我有什么好的工具推荐.正好前两天在网上看到一款做文档的利器sphinx+reStructText,当时在ubuntu下搭了下环境试了试, ...
sphinx 项目根目录_如何使用Sphinx工具记录Django项目
sphinx 项目根目录 I recently visited a company where I had a nice talk with one of its employees. We talk ...

Sphinx index.rst

Sphinx index.rst相关推荐

最新文章

热门文章