diff options
| author | jwansek <eddie.atten.ea29@gmail.com> | 2022-04-28 17:52:47 +0100 |
|---|---|---|
| committer | jwansek <eddie.atten.ea29@gmail.com> | 2022-04-28 17:52:47 +0100 |
| commit | fc2d6441596e547ba8d8c9957b092724d8bb9ae3 (patch) | |
| tree | 6c5cf66c2f6057f45f37bf4a8d365fac084ca1c7 /docs/source/index.rst | |
| parent | d0f18184cb8619a1b4c1c540cf6af66eaacac239 (diff) | |
| download | Smarker-fc2d6441596e547ba8d8c9957b092724d8bb9ae3.tar.gz Smarker-fc2d6441596e547ba8d8c9957b092724d8bb9ae3.zip | |
Started writing documentation
Diffstat (limited to 'docs/source/index.rst')
| -rw-r--r-- | docs/source/index.rst | 34 |
1 files changed, 34 insertions, 0 deletions
diff --git a/docs/source/index.rst b/docs/source/index.rst new file mode 100644 index 0000000..c238253 --- /dev/null +++ b/docs/source/index.rst @@ -0,0 +1,34 @@ +Welcome to Smarker's documentation! +=================================== + +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` |