.. _irfpy_documentation:

==============================
``irfpy`` and documentation
==============================

Documentation is a heart of ``irfpy``.

For documentation, ``irfpy`` rely fully on `Sphinx <https://sphinx-doc.org>`_.
for production and formatting.
Therefore, it is recommended for developer to use their syntax.

.. note::

        However, do not aim perfect from the beginning.
        Yes, it is "Better Than Nothing"
        
The sphinx syntax is very simple to get used to.
The syntax is based on ``restructuredtext`` markup, with its extension.

To start with, you may find the link in the sidebar of this page ``Show Source``.
Click the link, then the source code of this page will be shown.

To learn how to markup the text, there are many webpages.
Google with "restructuredtext" (or "ReST") and "Sphinx".
Some links are here:

- http://rest-sphinx-memo.readthedocs.io/en/latest/ReST.html
- http://docutils.sourceforge.net/docs/user/rst/quickref.html
- http://www.sphinx-doc.org/en/stable/markup/index.html
- http://matplotlib.org/sampledoc/cheatsheet.html
- http://sphinx-users.jp (Japanese)