Documentation for all index types #136
Conversation
The page is long and maybe should be split, but I can't figure out how to do it in a clean way.
|
I think I'm finally ready to get some human feedback on this. If you want to review this, click "Click here to see a preview of the documentation." in the checks below (the page doesn't live update if I push new commits so be sure to always click it again to get the latest version). The thing to look at here is the "Guide to NumPy Indexing" on the left sidebar. Any and all feedback is welcome, whether small or broad. One thing I'm not sure about is whether the "Multidimensional Indices" page should be split into multiple smaller pages. The page is long and I feel like it would be useful, but I'm not sure how to best do it without interrupting the flow and keeping the overall layout. I don't really want to create nested pages in the guide because they are confusing. |
The guide already has an introduction.
Referencing a label makes it anchor the header, making it yellow and adding the anchor to the URL, so referencing the document directly is preferable.
|
It's going to be easier to get reviews on this if it's live. Feel free to comment on the diff of this PR. |
|
The page is live as a soft launch https://quansight-labs.github.io/ndindex//indexing-guide/index.html. Further updates are at #176. |
Extend the slices documentation to document all NumPy index types.
This still a work in progress.