Add required sphinx packages

README.md

@@ -5,20 +5,21 @@ The PAF Backend Simulator is part of the [Radioblocks]() project. The counterpar
 
 ## Install
 
-It is recommended to create a virtual environment before installing the packaged.
+It is recommended to create a virtual environment before installing the package.
 
 `python -m venv /path/to/venv/`
 
-Activate the venv by
+Activate the venv
 
 `source /path/to/venv/bin/activate`
 
 The project is managed by the `pyproject.toml`-file. Hence, an installation with `pip` is the prefered way.
-Clone the repo:
+
+In the next step we clone the pafsim repository:
 
 `git clone https://gitlab.mpcdf.mpg.de/nesser/pafsim && cd pafsim`
 
-Then install it with
+and install it
 
 `pip install .`
 

doc/index.rst

-:ref:`genindex`
\ No newline at end of file
+.. PAFFrontendSim documentation master file, created by
+   sphinx-quickstart on Tue Dec 19 11:53:43 2023.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to PAFFrontendSim's documentation!
+==========================================
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+   modules
+
+.. toctree::
+   :maxdepth: 10
+   :caption: Additions:
+
+   introduction.rst
+   users_guide.rst
+   developer_guide.rst
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`