Sphinx 学习笔记
========================================

.. toctree::
   :maxdepth: 2
   :caption: Contents:

   build_readthedocs
   edit_tips
   blog


偶然间发现 Sphinx ，这个用 Python 构建的文档库是一个非常好用的东西，有许多可以研究的地方，
因此打算在这上面投入一部分时间。

Sphinx 是一个文档构建应用（系统），可以从源代码构建文档，也可以直接手写文档。具体的做法
可以通过查询相关的文档来查看。话说 ``vscode`` 居然不支持 ``.rst`` （即本文使用的文件格式），
也是令人震惊。

安装 Sphinx
---------------------

.. code:: bash

    pip install sphinx


参考
-----

1. https://doclikecode.readthedocs.io/zh_CN/latest/1_sphinx/sphinx101.html


Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`


LICENSE
=======

https://creativecommons.org/licenses/by-nc-sa/3.0/cn/