-
-
Notifications
You must be signed in to change notification settings - Fork 11k
DOC: add missing docs #12250
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
DOC: add missing docs #12250
Conversation
Good idea to clean this up. A few comments:
That's not quite how it works, e.g. the
That sounds right. Would be good to verify that all content is already present in the docs - did you do that? |
doc/source/dev/index.rst
Outdated
@@ -6,6 +6,7 @@ Contributing to NumPy | |||
:maxdepth: 3 | |||
|
|||
conduct/code_of_conduct | |||
conduct/report_handling_manual |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This should be removed again. It's not something that should be visible under "Contributing to NumPy" (the main page of the dev guide). The page is linked already from the CoC itself.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Removed
@@ -5,5 +5,6 @@ NumPy internals | |||
.. toctree:: | |||
|
|||
internals.code-explanations | |||
alignment |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
this looks good to add. the section headers need an edit though, I propose:
- a new page title, for example "Memory alignment"
- change the 3 current section headers to lower-level subsection headers, so the titles will not show up on https://docs.scipy.org/doc/numpy/reference/
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done
I broke these::
out into a separate issue #12261 |
Moved to dev section |
@rgommers ping |
Okay, in it goes. Thanks @mattip |
Some of the top-level
*.rst.txt
docs were not part of our on-line or PDF docs:DISTUTILS.rst.txt
C_STYLE_GUIDE.rst.txt
Additionally, the
conduct/report_handling_manual.rst
andalignment.rst
documents were not linked into a TOC, thus unavailable via links.The top level
CAPI.rst.txt
is not linked in, I think we can drop or move it to informational NEPS if it has historical relevance still.Edit: "orphaned" dos that are not in a TOC