Abstract
Documentation is arguably the most difficult part of any project. Code tends to come fairly easy to programmers, but documentation requires a different set of skills because the audience is strictly human. The magnitude of the differences can vary greatly between projects and audiences. Sometimes all that’s necessary is some example code, whereas other topics can fill entire books and still have plenty left to cover.
This is a preview of subscription content, log in via an institution to check access.
Access this chapter
Tax calculation will be finalised at checkout
Purchases are for personal use only
Notes
- 1.
See “PEP 8: Style Guide for Python Code,” http://www.python.org/dev/peps/pep-0008 .
- 2.
See “PEP 257: Docstring Conventions,” http://www.python.org/dev/peps/pep-0257 .
- 3.
See “Docutils: Documentation Utilities,” http://docutils.sourceforge.net .
- 4.
See “Sphinx: Python Documentation Generator,” http://sphinx.pocoo.org .
Author information
Authors and Affiliations
Rights and permissions
Copyright information
© 2019 J. Burton Browning and Marty Alchin
About this chapter
Cite this chapter
Browning, J.B., Alchin, M. (2019). Documentation. In: Pro Python 3. Apress, Berkeley, CA. https://doi.org/10.1007/978-1-4842-4385-5_8
Download citation
DOI: https://doi.org/10.1007/978-1-4842-4385-5_8
Published:
Publisher Name: Apress, Berkeley, CA
Print ISBN: 978-1-4842-4384-8
Online ISBN: 978-1-4842-4385-5
eBook Packages: Professional and Applied ComputingApress Access BooksProfessional and Applied Computing (R0)