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

Add configuration key to readthedocs.yml #2358

Merged
merged 7 commits into from
Jan 21, 2025
Merged

Conversation

RDaxini
Copy link
Contributor

@RDaxini RDaxini commented Jan 14, 2025

  • Closes Docs build fail: sphinx configuration file is missing #2357
  • 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.

Not super familiar with build tools but wanted to give this a go... seemed straightforward.

@RDaxini RDaxini added this to the v0.11.3 milestone Jan 14, 2025
@RDaxini RDaxini added the build tools Pipelines, CI, GH actions label Jan 14, 2025
@RDaxini RDaxini marked this pull request as ready for review January 14, 2025 18:23
@RDaxini RDaxini added the bug label Jan 14, 2025
@cwhanse
Copy link
Member

cwhanse commented Jan 14, 2025

Can you help me see the "bug" that is fixed? A page that builds correctly now that didn't before?

Edit: nvm I see the associated issue.

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.

LGTM! 🚀
I've left a small note regarding whatsnew's wording down below.

For context, this is the Sphinx blog post that describes the breaking change in detail: https://about.readthedocs.com/blog/2024/12/deprecate-config-files-without-sphinx-or-mkdocs-config/

docs/sphinx/source/whatsnew/v0.11.3.rst Outdated Show resolved Hide resolved
@RDaxini
Copy link
Contributor Author

RDaxini commented Jan 20, 2025

I think this is ready to merge (after #2352)

@wholmgren
Copy link
Member

@RDaxini can you please resolve the conflict and then we can merge?

@RDaxini
Copy link
Contributor Author

RDaxini commented Jan 21, 2025

@RDaxini can you please resolve the conflict and then we can merge?

Done

Copy link
Member

@wholmgren wholmgren left a comment

Choose a reason for hiding this comment

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

thanks @RDaxini!

@wholmgren wholmgren merged commit d651362 into pvlib:main Jan 21, 2025
26 checks passed
@RDaxini RDaxini deleted the sphinx_config branch January 21, 2025 21:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug build tools Pipelines, CI, GH actions
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Docs build fail: sphinx configuration file is missing
4 participants