|
|
# 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
|
| ... | |
... | |
| ... | | ... | |
