docs/documentation.rst

   1 .. _documentation-guide:
   2
   3 Documentation Guide
   4 ===================
   5
   6 This guide provides details on how to contribute to the documetantion of
   7 Spectrometer. The style guide we follow for documentation is the python
   8 documentation style guide. See:
   9
  10     https://docs.python.org/devguide/documenting.html
  11
  12 To build and review the documentation locally you first require to have
  13 installed locally:
  14
  15 * python
  16 * python-tox
  17
  18 Which both should be available in most distribution's package managers.
  19
  20 Then simply run tox and open the html produced via your favourite web browser.
  21
  22 .. code-block:: bash
  23
  24     tox -edocs
  25     firefox .tox/docs/tmp/html/index.html