Skip to main content

Documentation

  • Chapter
  • First Online:
Pro Python
  • 7116 Accesses

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

Chapter
USD 29.95
Price excludes VAT (USA)
  • Available as PDF
  • Read on any device
  • Instant download
  • Own it forever
eBook
USD 39.99
Price excludes VAT (USA)
  • Available as EPUB and PDF
  • Read on any device
  • Instant download
  • Own it forever

Tax calculation will be finalised at checkout

Purchases are for personal use only

Institutional subscriptions

Notes

  1. 1.

    http://www.python.org/dev/peps/pep-0008/.

  2. 2.

    http://www.python.org/dev/peps/pep-0257/.

  3. 3.

    http://docutils.sourceforge.net/.

  4. 4.

    http://sphinx.pocoo.org/.

Author information

Authors and Affiliations

Authors

Rights and permissions

Reprints and permissions

Copyright information

© 2014 J. Burton Browning

About this chapter

Cite this chapter

Browning, J.B., Alchin, M. (2014). Documentation. In: Pro Python. Apress, Berkeley, CA. https://doi.org/10.1007/978-1-4842-0334-7_8

Download citation

Publish with us

Policies and ethics