spinx going book

This commit is contained in:
Steffen Illium
2023-12-12 17:51:37 +01:00
parent 7feba6d452
commit e7933985cb
44 changed files with 392 additions and 310 deletions

View File

@ -1,30 +1,20 @@
.. marl-factory-grid documentation master file, created by
sphinx-quickstart on Fri Dec 1 12:55:36 2023.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Welcome to marl-factory-grid's documentation!
=============================================
.. mdinclude:: ../../README.md
Test
.. toctree::
:maxdepth: 1
:caption: Contents:
:caption: Table of Contents
:titlesonly:
installation
usage
modifications
code
source
.. note::
This project is under active development.
.. mdinclude:: ../../README.md
Indices and tables
==================
------------------
* :ref:`genindex`
* :ref:`modindex`