=========================
为PyMiner贡献文档
=========================

本系列教程将介绍如何为 ``pyminer`` 撰写文档。

本系列将分为以下部分展开：

.. toctree::
    :maxdepth: 2

    compile.md
    choose_position.md
    rst_guide.rst
    md_guide.rst

本教程建立在本人完整配置sphinx并进行二次开发的基础上完成的，
由于本人对具体的技术细节非常熟悉，因此难免会漏下一些可能对第一次使用sphinx的朋友比较关键的细节。
不管有任何问题，都欢迎在QQ群中与我（1641210337）交流。
如果可以帮助完善您在文档撰写中的体会，将会是更好的。
