cheat/sphinx.txt at master · cangermueller/cheat · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
# Links
https://pythonhosted.org/an_example_pypi_project/sphinx.html

# Misc
sphinx-quickstart

.. automodule: name_module
  :members:

.. autoclass: ClassName
  :members:
  :special-members: // __init__

# config.py
sys.path.insert(0, os.path.abspath('../../mf')) // relative to /source folder


# ReStructured Text
    """
    Return the sum of two numbers.

    :param a: The first number
    :type a: int
    :param b: The second number
    :type b: int
    :returns: The sum of a and b
    :rtype: int
    :raises: nothing

    .. note::
        Sometimes the function :func:`sum_ab` in the module :mod:`numpy`, or class :class:`ndarray` is better.
        Use the **intersphinx** extension for references modules like :mod:`numpy` or `pickle`.
        Include equations by :math:`\\gamma`

    .. warning::
        Severe warning!

    >>> add_ab(1, 2)
    '3'
    >>> add_ab(3, 4)
    '7'

    """