The SciPy Documentation Project (Technical Overview)
Stefan Johann Van der Walt
stefan@sun.ac.za -
University of Stellenbosch, South Africa
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.
Citation
S Van der Walt, The SciPy Documentation Project (Technical Overview) in Proceedings of the 7th Python in Science conference (SciPy 2008), G Varoquaux, T Vaught, J Millman (Eds.), pp. 27-28
BibTeX entryFull text PDF
![](/static/images/pdf_ico.png)
Copyright
The content of the articles of the Proceedings of the Python in
Science Conference is copyrighted and owned by their original
authors.
Terms of use For republication or other use of the material published, please contact the copyright owners to obtain permission.
Terms of use For republication or other use of the material published, please contact the copyright owners to obtain permission.