Sort the developer madness and improve your productivity at DEX by Sentry on Sept 28

Sphinx, MyST, and Python Docs in 2022

Episode #354, published Thu, Feb 24, 2022, recorded Wed, Jan 19, 2022.

This episode is carbon neutral.
When you think about the power of Python, the clean language or powerful standard library may come to mind. You might certainly point to the external packages too. But what about the relative ease of picking up new libraries or even parts of the standard library? Documentation plays an important role there. And the tools in the Python space for building solid documentation and even publishing articles and books involving live code are huge assets.

In this episode, we have Paul Everitt, Pradyun Gedam, Chris Holdgraf, and Chris Sewell to update us on Sphinx, MyST-Parser, ExecutableBooks, JupyerBook, Sphinx Themes, and much more.



Links from the show

Pradyun’s personal website: pradyunsg.me
Chris’s personal website: predictablynoisy.com
Paul Everitt: @paulweveritt
Paul's free Sphinx and Markdown course: training.talkpython.fm

Sphinx: sphinx-doc.org
Python documentation: docs.python.org
ExecutableBooks: executablebooks.org
Jupyter Book: jupyterbook.org
MyST parser: myst-parser.readthedocs.io
Sphinx Book Theme: sphinx-book-theme.readthedocs.io
PyData Sphinx Theme: pydata-sphinx-theme.readthedocs.io
Sphinx Themes Gallery: sphinx-themes.org
Furo Theme: pradyunsg.me
sphinx-theme-builder: github.com
Python Documentation WG issue tracker: github.com
ReadTheDocs CZI: blog.readthedocs.com
Pandoc: pandoc.org
Google circa 1996: web.archive.org
Python doc example: docs.python.org
Tailwind doc example: tailwindcss.com/docs
Typora app: typora.io
CommonMark: commonmark.org
Watch this episode on YouTube: youtube.com
Episode transcripts: talkpython.fm

--- Stay in touch with us ---
Subscribe to us on YouTube: youtube.com
Follow Talk Python on Twitter: @talkpython
Follow Michael on Twitter: @mkennedy

Want to go deeper? Check out our courses

Panelists
Panelists
Episode sponsored by
Ads served ethically
X
Become a friend of the show
Stay in the know and get a chance to win our contests.
See our privacy statement about email communications.