- Add docstrings to your python code
- Use pdoc3
pip install pdoc3to create docs from the docstrings - Upload the docs to your userpage
- Mention the docs in your README.md and maybe add them here
Example on how to generate docs and upload them to your userpage:
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/