docs/source/index.rst


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

.. mdinclude:: readme.md

Setting up
----------

* Set up a MySQL/MariaDB server. The database will be generated automatically.
* Add ``smarker.conf`` to the root directory of the code. See :ref:`configfile` for the structure of this file.
* Decide how you want to run the program: with or without docker.

.. toctree::
   :maxdepth: 2
   :caption: Modules:
   
   reflect.rst
   database.rst

.. toctree::
   :maxdepth: 2
   :caption: Other Pages:

   configfile.rst
   docker.rst


Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`