Changes
Page history
Update How to document your python package
authored
Feb 07, 2023
by
Andi Gerken
Show whitespace changes
Inline
Side-by-side
How-to-document-your-python-package.md
View page @
a5731a53
# How to document your python packages
1.
Add docstrings to your python code
1.
Add docstrings to your python code
2.
Use pdoc3
`pip install pdoc3`
to create docs from the docstrings
2.
Use pdoc3
`pip install pdoc3`
to create docs from the docstrings
3.
Upload the docs to your userpage
3.
Upload the docs to your userpage
...
...
...
...
