index.rst 2.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960
  1. =======
  2. rfidacd
  3. =======
  4. This is the documentation of **rfidacd**.
  5. .. note::
  6. This is the main page of your project's `Sphinx`_ documentation.
  7. It is formatted in `reStructuredText`_. Add additional pages
  8. by creating rst-files in ``docs`` and adding them to the `toctree`_ below.
  9. Use then `references`_ in order to link them from this page, e.g.
  10. :ref:`authors` and :ref:`changes`.
  11. It is also possible to refer to the documentation of other Python packages
  12. with the `Python domain syntax`_. By default you can reference the
  13. documentation of `Sphinx`_, `Python`_, `NumPy`_, `SciPy`_, `matplotlib`_,
  14. `Pandas`_, `Scikit-Learn`_. You can add more by extending the
  15. ``intersphinx_mapping`` in your Sphinx's ``conf.py``.
  16. The pretty useful extension `autodoc`_ is activated by default and lets
  17. you include documentation from docstrings. Docstrings can be written in
  18. `Google style`_ (recommended!), `NumPy style`_ and `classical style`_.
  19. Contents
  20. ========
  21. .. toctree::
  22. :maxdepth: 2
  23. Overview <readme>
  24. License <license>
  25. Authors <authors>
  26. Changelog <changelog>
  27. Module Reference <api/modules>
  28. Indices and tables
  29. ==================
  30. * :ref:`genindex`
  31. * :ref:`modindex`
  32. * :ref:`search`
  33. .. _toctree: http://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html
  34. .. _reStructuredText: http://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html
  35. .. _references: http://www.sphinx-doc.org/en/stable/markup/inline.html
  36. .. _Python domain syntax: http://sphinx-doc.org/domains.html#the-python-domain
  37. .. _Sphinx: http://www.sphinx-doc.org/
  38. .. _Python: http://docs.python.org/
  39. .. _Numpy: http://docs.scipy.org/doc/numpy
  40. .. _SciPy: http://docs.scipy.org/doc/scipy/reference/
  41. .. _matplotlib: https://matplotlib.org/contents.html#
  42. .. _Pandas: http://pandas.pydata.org/pandas-docs/stable
  43. .. _Scikit-Learn: http://scikit-learn.org/stable
  44. .. _autodoc: http://www.sphinx-doc.org/en/stable/ext/autodoc.html
  45. .. _Google style: https://github.com/google/styleguide/blob/gh-pages/pyguide.md#38-comments-and-docstrings
  46. .. _NumPy style: https://numpydoc.readthedocs.io/en/latest/format.html
  47. .. _classical style: http://www.sphinx-doc.org/en/stable/domains.html#info-field-lists