-
-
Notifications
You must be signed in to change notification settings - Fork 12.1k
Description
Documentation
This issue proposes a redesign of the NumPy Documentation website at www.numpy.org/devdocs. This issue is part of Google Season of Docs to help redesign, add content, and build community in NumPy documentation. My suggestions are designed to implement NEP 44
I would like to make three updates to the website:
- Match the landing page to the table of
contents - Rename "NumPy basics" to "NumPy Fundamentals"
- Remove "Explanations" and use "NumPy Fundamentals" as the
explanations section (following the Divio docs
descriptions)
1- Match the landing page to the table of contents
The current landing page does not match the main documentation table of contents. As the user clicks on an item in the main page, new content appears and the order is slightly different for reference, the current landing vs table of contents is show below:
| Landing Page | Table of Contents |
|---|---|
For users:
For developers/contributors:
Meta Information:
|
|
Proposed Landing vs Table of Contents:
I propose the new landing page and table of contents should match as such:
| Landing Page | Table of Contents |
|---|---|
For users:
For developers/contributors:
Meta Information:
|
|
2- Rename "NumPy basics" to "NumPy Fundamentals" and reorganize content
The NumPy Basics section consists of the following content:
- Data types
- Array creation
- I/O with NumPy
- Indexing
- Broadcasting
- Byte-swapping
- Structured arrays
- Writing custom array containers
- Subclassing ndarray
These articles have very useful information for users, but they do not cover the basics. The basics are covered in Absolute Basics for beginners. I propose adding a description to these articles as Explanation Material and relabel the section as "NumPy Fundamentals". This documentation space can be used to clarify parts of NumPy and describe design decisions in NumPy. Most of this content is already there, but it will help to
capture it in its own section and label it.
I also propose the content be reorganized from common/basic tasks to less common/advanced tasks as such:
- Array creation
- Indexing
- I/O with NumPy
- Data types
- Broadcasting
- Byte-swapping
- Structured arrays
- Writing custom array containers
- Subclassing ndarray
3- Remove "Explanations" and use "NumPy Fundamentals" as the explanations section (following the Divio docs descriptions)
Following from part 2, by using "NumPy Basics Fundamentals" as the explanation section in the documentation, there is no need for the "Explanations" link. The current link brings the user to a subset of the "NumPy Basics":
- Broadcasting