GenericMappingTools / pygmt

A Python interface for the Generic Mapping Tools.
https://www.pygmt.org
BSD 3-Clause "New" or "Revised" License
760 stars 218 forks source link

Move "Reference Documentation" up in sidebar order #1535

Closed willschlitzer closed 2 years ago

willschlitzer commented 3 years ago

Should the "Reference Documentation" sub-section be moved up the sidebar in the PyGMT documentation? GMT has "Getting Started" followed by "Reference Documentation", and I think our sidebar should match it. As the User Guide has expanded, the entire sidebar likely won't fit on most screens and will require scrolling to see the reference documentation.

seisman commented 3 years ago

As the User Guide has expanded, the entire sidebar likely won't fit on most screens and will require scrolling to see the reference documentation.

xref: https://github.com/GenericMappingTools/pygmt/issues/1191

maxrjones commented 2 years ago

@willschlitzer, what's your opinion on this with the new sidebar structure: https://www.pygmt.org/dev/? Would you still prefer for the reference documentation to be before the user guide?

willschlitzer commented 2 years ago

I would still prefer the reference documentation up higher, like in the GMT docs, but I think it looks much better now that the tutorial list isn't super long.

maxrjones commented 2 years ago

I would still prefer the reference documentation up higher, like in the GMT docs, but I think it looks much better now that the tutorial list isn't super long.

I would be fine with this change.

seisman commented 2 years ago

I would still prefer the reference documentation up higher, like in the GMT docs, but I think it looks much better now that the tutorial list isn't super long.

I prefer to keep the "Reference documentation" at the current position (i.e., below the "User Guide"), as what other projects do (e.g., pandas, scipy, xarray).

willschlitzer commented 2 years ago

It seems like there's not much of a desire to change the sidebar, especially since it has been consolidated in #1603, so I'm closing this issue