Docs

.gitignore

@@ -10,10 +10,11 @@ __pycache__/
 *json
 *cgo 
 *.out
-*dcd
-*png
+*.dcd
+*.png
 notebooks/*
 replot.py
+run_all.sh 
 # C extensions
 *.so
 

.readthedocs.yaml

@@ -0,0 +1,14 @@
+
+version: 2
+
+build:
+  os: "ubuntu-20.04"
+  tools:
+    python: "3.9"
+
+sphinx:
+  configuration: docs/source/conf.py
+
+python:
+  install:
+    - requirements: docs/requirements.txt

Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = source
+BUILDDIR      = build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

README.md

@@ -3,6 +3,7 @@
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
 ![Test](https://github.com/MQSchleich/dylightful/actions/workflows/python-app.yaml/badge.svg?branch=main)
 [![codecov](https://codecov.io/gh/simonw/asgi-csrf/branch/main/graph/badge.svg)](https://codecov.io/gh/MQSchleich/dylightful/)
+[![Documentation Status](https://readthedocs.org/projects/dylightful/badge/?version=latest)](https://dylightful.readthedocs.io/en/latest/?badge=latest)
 
 # Package to develop Markov Analysis of Dynophores
 
@@ -25,8 +26,15 @@ To install the necessary packages it is recommended to use the 'conda' package m
 pip install -r requirements.txt
 ```
 
-# Convert Dynophore trajectory 
-use *parser.py*
-```
+# Tutorial 
+
+For a tutorial on how to apply the package to a dynophore check the notebook in [tutorial](https://github.com/MQSchleich/dylightful/tutorial)
+
+For a deep walkthrough checkout the files in [notebooks](https://github.com/MQSchleich/dylightful/notebooks/)
+
+
+# Documentation
+
+The full documentation is on https://dylightful.readthedocs.io/en/latest/
+
 
-```