Documentation news 2018

Contents

• Documentation news 2018

  • Pratical sphinx (2018-05-12, pycon2018)

  • Markdown Descriptions on PyPI (2018-03-16)

    • Add a new argument in setup.py

    • Upgrade your setuptools

  • Bringing interactive examples to MDN

Pratical sphinx (2018-05-12, pycon2018)

See also

• https://speakerdeck.com/willingc/practical-sphinx

• https://twitter.com/WillingCarol

• https://twitter.com/WillingCarol/status/995793005348040704

Markdown Descriptions on PyPI (2018-03-16)

See also

• https://dustingram.com/articles/2018/03/16/markdown-descriptions-on-pypi

Finally !

I’m really excited to say that as of today, PyPI supports rendering project descriptions from Markdown! This has been a oft-requested feature and after lots of work (including the creation of PEP 566) it is now possible, without translating Markdown to rST or any other hacks!

Add a new argument in setup.py

PEP 566 added new metadata fields including Description-Content-Type. To set the content type for your long description, you’ll need to add the following argument to the setup() call in your projects setup.py:

        long_description=long_description,
+   long_description_content_type="text/markdown",

Upgrade your setuptools

You’ll need a version of setuptools>=38.6.0 to be able to produce a distribution with the new metadata.

$ pip install -U setuptools

Bringing interactive examples to MDN

See also

• https://hacks.mozilla.org/2018/03/bringing-interactive-examples-to-mdn/