===========================
How to write documentations
===========================

Date: |today|

Sphinx
======
ドキュメント作成に Sphinx を使用している．

Sphinx は，reStructuredText記法で書かれたテキストファイルを HTML などに変換するツールである．
後述で，Markdown記法にも対応することが可能．
多くのドキュメントで使用され，主に Python Docs（official, numpy, matplotlib, etc.）で使われる．  

無料で読める本 `Sphinxの使い方 <https://zenn.dev/y_mrok/books/sphinx-no-tsukaikata>`_


.. toctree::
    :maxdepth: 3
    :caption: ドキュメントを作る準備

    enviroment
    file_structure
    ./usage_sphinx.md


.. toctree::
    :maxdepth: 3
    :caption: Markdown記法

    markdown
    ./markdown_troubleshooting.md