Skip to content
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

Restructure user guide with subsections #2310

Open
wants to merge 13 commits into
base: main
Choose a base branch
from

Conversation

RDaxini
Copy link
Contributor

@RDaxini RDaxini commented Nov 26, 2024

  • Closes Restructure the user guide with subsections #2302
  • I am familiar with the contributing guidelines
  • Tests added
  • Updates entries in docs/sphinx/source/reference for API changes.
  • Adds description and name entries in the appropriate "what's new" file in docs/sphinx/source/whatsnew for all changes. Includes link to the GitHub Issue with :issue:`num` or this Pull Request with :pull:`num`. Includes contributor name and/or GitHub username (link with :ghuser:`user`).
  • New code is fully documented. Includes numpydoc compliant docstrings, examples, and comments where necessary.
  • Pull request is nearly complete and ready for detailed review.
  • Maintainer: Appropriate GitHub Labels (including remote-data) and Milestone are assigned to the Pull Request and linked Issue.

#2302 for discussion

@RDaxini
Copy link
Contributor Author

RDaxini commented Nov 26, 2024

--edit: objective changed. See linked issue for discussion
Ready for an initial review

One observed limitation: visible main header section titles is currently limited to five headers, so the last one is now kept under "more"
Can this maximum be changed?
If not, I suggest swapping the order of "whatsnew" and "contributing". Having whatsnew at the end seems more intuitive to me, so I'd like to suggest this anyway even if all sections are listed upfront (no "more" list)

@RDaxini RDaxini marked this pull request as ready for review November 26, 2024 22:30
@RDaxini RDaxini changed the title [WIP] Create "learning" page to organize docs Create "learning" page to organize docs Nov 26, 2024
@RDaxini RDaxini added this to the v0.11.2 milestone Nov 26, 2024
@RDaxini RDaxini marked this pull request as draft December 4, 2024 03:44
@RDaxini RDaxini modified the milestones: v0.11.2, v0.11.3 Dec 10, 2024
@RDaxini RDaxini changed the title Create "learning" page to organize docs [WIP] Restructure user guide with subsections Dec 10, 2024
@kandersolar
Copy link
Member

@RDaxini if you merge main into this PR to bring in #2332 I think the RTD build will start working again

@RDaxini
Copy link
Contributor Author

RDaxini commented Dec 23, 2024

@kandersolar sure np I remember 😅 you're too fast 😂

@RDaxini RDaxini marked this pull request as ready for review December 23, 2024 18:16
@RDaxini
Copy link
Contributor Author

RDaxini commented Dec 23, 2024

@RDaxini RDaxini changed the title [WIP] Restructure user guide with subsections Restructure user guide with subsections Dec 23, 2024
Copy link
Member

@kandersolar kandersolar left a comment

Choose a reason for hiding this comment

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

This looks great!

Would it make sense to get rid of index.rst and have the User Guide link go straight to Package Overview?

docs/sphinx/source/user_guide/index.rst Outdated Show resolved Hide resolved
@RDaxini
Copy link
Contributor Author

RDaxini commented Dec 23, 2024

Would it make sense to get rid of index.rst and have the User Guide link go straight to Package Overview?

In my view, it's not a bad idea and it'd probably work fine for me personally. The downside I see is for users who navigate by, or like to view, the subsubsections of each subsection. This makes me lean slightly away from the directing straight to package overview, but do many people navigate/view or docs like this...?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Restructure the user guide with subsections
2 participants