Contributing to the NumPy Documentation

Video: Contributing to the NumPy Documentation (~50 minutes)

About NumPy

NumPy is a fundamental, open-source Python library for N-dimensional array programming used extensively for data analysis and scientific programming. As a community-driven project, NumPy is mainly sustained by open-source contributions. This talk focuses on avenues of contribution to the project documentation, an integral part of the software.

NumPy Video Playlist

NumPy: Its History, Governance & How to Contribute (~60 min)

Live demo of contributing to NumPy (~25 min)

00:22:41 Live demo of contributing (setting up virtual environment, working on an issue, submit a pull request)

Sphinx for Python Documentation Tutorial (~75 min)

Live demo of contributing to NumPy (~15 min)

00:43:27 An example pull request to the NumPy documentation

Intro to NumPy Array Operations (~45 min)

Resources (+ all the links from the Slides)

Slides: Slides
NumPy: https://numpy.org
video: Intro to NumPy Array Operations
video: NumPy: Its History, Governance and How to Contribute
video: Sphinx for Python Documentation Tutorial
NumPy tutorials
NumPy tutorials on GitHub
Style Guide
NumPy development
Documentation as a way to build community
NumPy community (link to slack is on this page)
NumPy playlist: these videos have examples of contributing to the NumPy documentation
NEP 44 — Restructuring the NumPy documentation
Diátaxis - A systematic approach to technical documentation authoring
NumPy Contributor’s Comic
NumPy YouTube
NumPy Community
Setting up your development environment – Building the NumPy API and reference docs

Connect with the Speaker: Mukulika Pahari

Mukulika is a maintainer for the NumPy documentation and has been involved in the community since 2021. She is also studying to be an oceanographer and likes working on scientific software. She was a Technical Writer via Google Season of Docs in 2021.