The SciPy Documentation Project (Technical Overview)
By Stéfan J. Walt. 2008
This summer saw the first NumPy Documentation Marathon, during which many thousands of lines of documentation were written. In addition, a web framework was developed which allows the community to contribute docstrings in a wiki-like fashion, without needing access to the source repository. The new reference guide, which is based on these contributions, was built using the popular Sphinx tool. While the documentation coverage is now better than ever, there is still a lot of work to be done, and we encourage interested parties to register and contribute further. This paper gives a more detailed overview of the events leading to this project, and of the technical goals achieved.
How researchers see this paper
The researchers whose trusted networks rank it highest, strongest advocate first. Every researcher gets a different order.
- Pauli Virtanen
- R. Gommers
- K. Jarrod Millman
- Charles R. Harris
- S. Van Der Walt
- Pearu Peterson
- T. Oliphant
- Fernando Pérez
Citations in the corpus
- Developing Open-Source Scientific Practice * (2018, methodology): “For instance, the SciPy community has developed an online wiki-like documentation editing system [33] on top of Sphinx that leverages the documentation standard discussed in § 3.”
- SciPy 1.0-Fundamental Algorithms for Scientific Computing in Python (2019, methodology): “The SciPy Documentation Project 33,34 used these tools to complete documentation of SciPy’s user-facing functionality: offering t-shirts to contributors from around the world in exchange for high-quality text, it collected contributions from over 75 people to produce an 884-page manual 35 .”