Getting up for Project
I came across a new program - Google Season of Docs in the month of April’19. The origin of this program is basically from the GSoC mentor mailing list. I remember after completion of GSoC 2018 few members pointed out that writing documentation is essential along with the maintaing and developing the software.
Past GSoC mentors and students proposed Google to organize a separate program, just for improving/enhancing the documentation of the Open Source Softwares.
Next year 2019 Google announced the program - Google Season of Docs.
I found very interesting project ideas from various organizations. NumPy and SciPy project idea attracted me.
The project is Restructuring and redesigning of the NumPy & SciPy website. I used to read API docs in numpy site which has pretty old UI and bit redundent documentation. I decided to work on it.
Abstract of the proposal
NumPy is an incredible library to perform mathematical and statistical operations. It works perfectly well for multi-dimensional arrays and matrices multiplication. NumPy version 1.0 was released in 2006 and now it is widely used in mathematical, scientific, engineering, and data science programming.
NumPy API documentation provide good description about the method and example.
But it is still using old Sphinx template and modern days we have better SSG(Static Site Generator) tools. Also there is need of restructuring of pages and making it more useful for users by adding new examples and tutorials.
My main intention is :
● To design and develop better UI for www.numpy.org.
● To enhance and modify the contents of www.numpy.org: NumPy User Guide, NumPy Benchmarking, F2Py Guide, NumPy Developer Guide, Building and Extending the Documentation, NumPy Reference , About NumPy, Reporting bugs and all other related to Development pages.
● Add contents about when to use NumPy and when to use XND, Dask array Python libraries, which provides similar APIs.
● To preserve the Python API documentation which is generated using Sphinx (current Documentation Processing Tool for Python, which is the best tool, as per my knowledge for Python) and work on better Sphinx theme.
Current www.numpy.org page uses Sphinx for generating the docs (using docstring written before the method or class) for Python APIs and also for writing the static pages like: NumPy User Guide, NumPy Benchmarking, F2Py Guide, NumPy Developer Guide, Building and Extending the Documentation, NumPy Reference , About NumPy pages.
So here we can shift the Static pages into better UI using SSG (Static Site Generator) frameworks.
The main point is, we should have the following features in NumPy Static pages :
Markdown based: So that technical writers don’t have to worry about installation. They can write simply in .md file. Anyone can click on edit button shown in website (new feature) and contribute (edit/suggest changes for the page in Github) to make it better. This will engage users to add new content or edit content to improve it.
Documentation Search: User should be having search box, so that they can easily and quickly find out relevant contents.
Document Versioning: User should be able to switch between the old and new versions easily. They should be able to checkout old version details as well.
Localization/Translation: User may have option to switch between languages. They should be able to read in native language as well.
New release note and Blogs: Website should be updated with new blog posts and news about the current development and roadmap. So kind of blogging should be present in landing page.
Fast development: Most of the SSG (Static Site Generator) frameworks are running in server and changes in file reflects immediately in UI. Also deploy and build process should be easy.
In future, if we want to change the framework, we use. Then it should be easy. Most of the frameworks support Markdown writing so just moving the .md files and few changes should be enough.
Framework should provide flexibility to extend the features or add new features easily. So framework should have plugin system.
● Mostly discussed in mailing thread: numpy-scipy-gsod, titled: ‘Interested to participate Google Season of Docs 2019 - NumPy’.
Project link :