Sphinx AutoDocs init

This commit is contained in:
Steffen Illium
2023-12-01 13:48:45 +01:00
parent 44c87f4c04
commit 7566161e28
11 changed files with 186 additions and 2 deletions

29
docs/source/index.rst Normal file
View File

@ -0,0 +1,29 @@
.. 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!
=============================================
.. toctree::
:maxdepth: 2
:caption: Contents:
installation
usage
modifications
code
.. autosummary::
:toctree: generated
.. note::
This project is under active development.
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`