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