How to docs
===========

How to build and run locally::

   # Install development requirements
   python3 -m pip install -r requirements-dev.txt

   # Start Sphinx autobuild through nox (installed with the last command)
   nox -s docs_autobuild

Open http://127.0.0.1:8000/ in your preferred browser.

For VS Code:

Install the extensions Python and reStructuredText. Hit Ctrl-Shift-P, search for "Python: Select Interpreter", and select Python 3. When VS Code asks how to generate HTML, select Sphinx. If VS Code doesn't ask, hit the gear icon in the statusbar when you have an .rst document open.

Some good resources:
http://docutils.sourceforge.net/docs/user/rst/quickref.html
https://sphinx-rtd-theme.readthedocs.io/en/stable/index.html

This is a section
-----------------

And a subsection
^^^^^^^^^^^^^^^^

**Bold**, *italic*, ``literal``

A reference to a footnote [#]_.

Inline math:
:math:`a^2 + b^2 = c^2`

Display math:

.. math::
   \frac{\pi^2}{2}

General code block:

::

   Code goes here, indentation is important!

Or, a bit shorter::

   Neat, huh?

With syntax highlighting:

.. code-block:: python

   def fac(n):
       return n * fac(n-1) if n > 1 else 1

.. attention::
   Attention

.. caution::
   Caution

.. danger::
   Danger

.. error::
   Error

.. hint::
   Hint

.. important::
   Important

.. note::
   Note

.. tip::
   Tip

.. warning::
   Warning

.. [#] A very nice footnote!
