0

How is better for Documentation in Python ?

MkDocs,Documentation

26th Mar 2019, 9:43 PM
Leonardo Gomez
Leonardo Gomez - avatar
2 Respostas
+ 4
I think pydocs and mkdocs serve different purpose. Pydocs is able to extract docstring comments from your codebase. If you follow the PEP257 guideline to carefully comment your code, then basically your documentation will write itself. https://www.python.org/dev/peps/pep-0257/ Mkdocs can be used to write up some user guide or tutorial for your program in wiki-like markdown syntax. This is not strictly related to your code structure, more like usage instructions.
27th Mar 2019, 1:55 PM
Tibor Santa
Tibor Santa - avatar
+ 1
Thanks
28th Mar 2019, 9:43 PM
Leonardo Gomez
Leonardo Gomez - avatar