How-to-document-your-python-package.md

+# How to document your python packages
+
+1. Add docstrings to your python code
+2. Use pdoc3 `pip install pdoc3` to create docs from the docstrings
+3. Upload the docs to your userpage
+4. Mention the docs in your README.md and maybe add them here
+
+Example on how to generate docs and upload them to your userpage:
+```bash
+pdoc -f --html -o /home/mi/mhocke/documentation robofish.behavior_test_utils robofish.gym_guppy robofish.rl robofish.electrofish.behavior robofish_commander
+rsync -avz --delete /home/mi/mhocke/documentation mhocke@login.zedat.fu-berlin.de:/home/m/mhocke/public_html/robofish/
+```