IntroductionΒΆ

Here you should introduce what your library does.

reStructuredText is powerful and extensible markup.

Important

Make sure to use directives such as:

  • .. important::
  • .. note::

See also

You can reference external libraries through intersphinx. For example, requests.post() or Session.

Warning

Some directives are available only on sphinx, such as .. deprecated::

Deprecated since version 0.0.1: This is useful to document breaking changes in the API.