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

Rearrange user guide files into subfolders #2411

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

Conversation

RDaxini
Copy link
Contributor

@RDaxini RDaxini commented Mar 14, 2025

  • Closes Suggestion: reorganise user guide folder with subfolders #2368
  • I am familiar with the contributing guidelines
  • 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.

@RDaxini RDaxini added this to the v0.12.0 milestone Mar 14, 2025
@echedey-ls
Copy link
Contributor

I'm afraid the changes are not that straight forward: the user guide cannot be seen now.
There are a lot of warnings in the docs build logs related to the new paths of the files: https://app.readthedocs.org/projects/pvlib-python/builds/27514320/

Attention to [...] installation.rst:136: WARNING: image file not readable: user_guide/_images/clonebutton.png
You may need to change the relative path of this image too.

(and the error reported in #2244 (comment) is also in the log)

@RDaxini
Copy link
Contributor Author

RDaxini commented Mar 15, 2025

@echedey-ls thanks, my bad, I didn't mean to mark it as ready for review as I hadn't gotten round to checking the build myself first. Sorry about that

@RDaxini RDaxini marked this pull request as draft March 15, 2025 03:19
@RDaxini RDaxini marked this pull request as ready for review March 17, 2025 00:32
Copy link
Contributor

@echedey-ls echedey-ls left a comment

Choose a reason for hiding this comment

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

Looks similar to the previous docs, good job. Below, two typos with the :caption: in the main index.

@RDaxini
Copy link
Contributor Author

RDaxini commented Mar 17, 2025

Why does the section navigation pane on the left disappear when entering one of the modeling topics items? :S No such issue when entering items from the other subsections

@kandersolar
Copy link
Member

I'm not sure, but it is suspect to define redundant toctrees in user_guide/index.rst and user_guide/XX/index.rst. I think the toctree in user_guide/index.rst should have only three entries: getting_started/index, extras/index etc.

@RDaxini
Copy link
Contributor Author

RDaxini commented Mar 17, 2025

I think the toctree in user_guide/index.rst should have only three entries: getting_started/index, extras/index etc.

That's what I tried originally (commit f18d138, build #27526199) but still no luck

I can still go back to that format though to avoid the errors about index.rst files not being included in any toctree
Not sure what to do about the section navigation pane issue though

@RDaxini
Copy link
Contributor Author

RDaxini commented Mar 19, 2025

I think the toctree in user_guide/index.rst should have only three entries: getting_started/index, extras/index etc.

That's what I tried originally (commit f18d138, build #27526199) but still no luck

I can still go back to that format though to avoid the errors about index.rst files not being included in any toctree Not sure what to do about the section navigation pane issue though

Edit: forgot to mention that by doing this (e.g. getting_started/index) we also end up with a double subsection menu in the navigation pane. Saw this earlier but just double checked again with the latest commits. Getting started -> getting started dropdown -> topics, instead of just getting started -> topics (always open, no dropdowns)
image

@kandersolar
Copy link
Member

we also end up with a double subsection menu in the navigation pane

Bother. It makes sense though. I suppose we could remove the :caption: titles and let sphinx handle it.

@RDaxini since these changes still needs some tweaks, I'm going to retag this PR for 0.12.1.

@kandersolar kandersolar modified the milestones: v0.12.0, v0.12.1 Mar 19, 2025
@RDaxini
Copy link
Contributor Author

RDaxini commented Mar 19, 2025

we also end up with a double subsection menu in the navigation pane

Bother. It makes sense though. I suppose we could remove the :caption: titles and let sphinx handle it.

Removing the :caption: ends up removing those sections in the navigation pane (local build image below)
Matching the order in which the subsections are listed in the main and subsection index.rst files (029a11e) fixes the disappearing section navigation pane though EDIT: still disappearing on the first subsection (PVSystem), but working fine on the other subsections...
image

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.

Suggestion: reorganise user guide folder with subfolders
3 participants