-
Notifications
You must be signed in to change notification settings - Fork 1k
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
Conversation
--edit: objective changed. See linked issue for discussion
|
@kandersolar sure np I remember 😅 you're too fast 😂 |
Ready for review again! Docs: https://pvlib-python--2310.org.readthedocs.build/en/2310/user_guide/index.html |
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 great!
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...? |
Co-Authored-By: Kevin Anderson <[email protected]>
Is the question about index.rst currently holding up this PR? Do we need more reviews? I'm happy to go with the suggestion if it's required for this to be merged. As mentioned, I see the benefit, but just was not sure whether it'd be universally beneficial for all. |
I mildly prefer keeping index.rst. I think this PR is good to merge as is. |
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.
Thanks @RDaxini!
Tests addedUpdates entries indocs/sphinx/source/reference
for API changes.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`
).remote-data
) and Milestone are assigned to the Pull Request and linked Issue.#2302 for discussion