You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
16 lines
346 B
16 lines
346 B
2 years ago
|
## Notes on creating documentation
|
||
|
|
|
||
|
|
Use pydoc-markdown:
|
||
|
|
|
||
|
|
<https://pypi.org/project/pydoc-markdown/>
|
||
|
|
|
||
|
|
`pydoc-markdown -p dryad2dataverse --render-toc > outputfile.md`
|
||
|
|
|
||
|
|
Note the `-p` switch for loading a package instead of a single module (ie, `-m`)
|
||
|
|
|
||
|
|
Can be used with mkdocs to produce JustTheDocs format static pages:
|
||
|
|
|
||
|
|
<https://www.mkdocs.org/>
|
||
|
|
|
||
|
|
|