Links in the `documenting-your-code` tutorial

documenting-your-code-links.md

Links in the documenting-your-code tutorial

Tutorial content + templates

Repository home https://github.com/deppen8/documenting-your-code

End product https://deppen8.github.io/documenting-your-code/

Jupyter Book _config.yml template https://jupyterbook.org/en/stable/customize/config.html

Jupyter Book _toc.yml template https://jupyterbook.org/en/stable/structure/toc.html#use-parts-to-organize-chapters

Jupyter Book .github/workflows/deploy.yml template https://jupyterbook.org/en/stable/publish/gh-pages.html#automatically-host-your-book-with-github-actions

Further resources

PEP 257 (Docstring Conventions) https://peps.python.org/pep-0257/

PEP 484 (Type Hints) https://peps.python.org/pep-0484/

Jupyter Book docs https://jupyterbook.org/

MyST docs https://myst-parser.readthedocs.io/

Sphinx docs https://www.sphinx-doc.org/

Sphinx autodoc docs https://www.sphinx-doc.org/en/master/usage/extensions/autodoc.html

Sphinx napoleon docs https://sphinxcontrib-napoleon.readthedocs.io/

Sphinx viewcode docs https://www.sphinx-doc.org/en/master/usage/extensions/viewcode.html

MyBinder https://mybinder.org/

interrogate https://interrogate.readthedocs.io/

pydocstyle http://www.pydocstyle.org/

xdoctest https://xdoctest.readthedocs.io/

VS Code autodocstring extension https://marketplace.visualstudio.com/items?itemName=njpwerner.autodocstring

PyCharm docstring generator https://www.jetbrains.com/help/pycharm/creating-documentation-comments.html

ReadTheDocs https://readthedocs.org/

WriteTheDocs https://www.writethedocs.org/

Diataxis https://diataxis.fr/

Sphinx Themes Gallery https://sphinx-themes.org/

NumPy tutorials https://numpy.org/numpy-tutorials

Matplotlib tutorials https://matplotlib.org/tutorials

A sample of people doing great things in the docs world

Daniele Procida https://twitter.com/evildmp

Melissa Weber Mendonça https://twitter.com/melissawm

Pradyun Gedam https://twitter.com/pradyunsg

Eric Holscher https://twitter.com/ericholscher

Hannah Story https://twitter.com/story645

Chris Holdgraf https://twitter.com/choldgraf