Skip to content

DOC: add main sections to toc #1946

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

Merged
merged 2 commits into from
Feb 27, 2018
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
43 changes: 42 additions & 1 deletion doc/index.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@

.. image:: _static/dataset-diagram-logo.png
:width: 300 px
:align: center
Expand Down Expand Up @@ -32,14 +31,44 @@ describing scientific data in widespread use in the Earth sciences:
Documentation
-------------

**Getting Started**

* :doc:`whats-new`
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's move this to the start of "Help & reference" instead.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Or move it to the very end? I kind of like a linear flow from new user to contributor (i.e., getting started -> user guide -> api -> developer zone...) and keep "what's new" out of that.

Also, a "what's new" section at the bottom of the toc may sound a little bit weird. Maybe rename it to "Release Notes"?

For example pandas has both "What's new" at the top and "Release Notes" at the bottom. I like it but I don't think we need both in xarray, though.

No strong opinion on this.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, I don't know :). We can also just leave it here.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah that was probably overthinking it :). Moved to to the start of "Help & reference".

* :doc:`why-xarray`
* :doc:`faq`
* :doc:`examples`
* :doc:`installing`

.. toctree::
:maxdepth: 1
:hidden:
:caption: Getting Started

whats-new
why-xarray
faq
examples
installing

**User Guide**

* :doc:`data-structures`
* :doc:`indexing`
* :doc:`computation`
* :doc:`groupby`
* :doc:`reshaping`
* :doc:`combining`
* :doc:`time-series`
* :doc:`pandas`
* :doc:`io`
* :doc:`dask`
* :doc:`plotting`

.. toctree::
:maxdepth: 1
:hidden:
:caption: User Guide

data-structures
indexing
computation
Expand All @@ -51,6 +80,18 @@ Documentation
io
dask
plotting

**Help & reference**

* :doc:`api`
* :doc:`internals`
* :doc:`contributing`

.. toctree::
:maxdepth: 1
:hidden:
:caption: Help & reference

api
internals
contributing
Expand Down