Documentation news 2020

Contents

• Documentation news 2020

  • New features of sphinx.ext.autodoc (typing) in sphinx 2.4.0 (2020-02-09)

  • Hypermodern Python Chapter 5: Documentation (2020-01-29) by https://twitter.com/cjolowicz/

New features of sphinx.ext.autodoc (typing) in sphinx 2.4.0 (2020-02-09)

See also

• Sphinx 2.4.0 (2020-02-09) new features (typing) of sphinx.ext.autodoc in sphinx

• Python typing

Hypermodern Python Chapter 5: Documentation (2020-01-29) by https://twitter.com/cjolowicz/

See also

• https://github.com/cjolowicz/hypermodern-python

• https://twitter.com/cjolowicz/

• https://cjolowicz.github.io/posts/hypermodern-python-05-documentation/#writing-documentation-using-restructuredtext

• https://www.ericholscher.com/blog/2016/mar/15/dont-use-markdown-for-technical-docs/

• https://cjolowicz.github.io/posts/hypermodern-python-04-typing/

In this fifth installment of the Hypermodern Python series, I’m going to discuss how to add documentation to your project.

In the previous chapter, we discussed how to add type annotations and type checking. (If you start reading here, you can also download the code for the previous chapter.)

Sphinx documentation is commonly written using reStructuredText (reST), although Markdown is also supported.

reStructuredText may not be as lightweight as Markdown, but its expressiveness and extensibility, among other reasons, make it more suitable for writing technical documentation.