.. index::
   pair: News ; 2020
   pair: Hypermodern Python ; 2020

.. _doc_2020:

=========================
Documentation news 2020
=========================

.. contents::
   :depth: 3

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

.. seealso::

   - :ref:`sphinx_2_4_0`
   - :ref:`python_typing`



.. _practical_sphinx_2020:

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

.. seealso::

   - 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.

:ref:`reStructuredText <rest_format>`  may not be as lightweight as Markdown_,
but its expressiveness and extensibility, among other reasons, make it more
suitable for writing technical documentation.

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

.. _`previous chapter`:  https://cjolowicz.github.io/posts/hypermodern-python-04-typing/