Autodoc.md

自动文档

sphinx

sphinx 无法支持 markdown native 数学公式 $X^2 + Y^2 = 1$ 的显示，可以通过 pandoc 将markdown转换为 .rst文件

pandoc xxx.md -t rst > xxx.rst

restructedtext

python code block

.. code-block:: python
    
    code here

Read The Docs

创建、托管和浏览文档

the example configuration file .readthedocs.yml and the explanation