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.

Sign up for GitHub

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

Jump to bottom

Fix sphinx warnings #300

Merged
merged 5 commits into from
Nov 16, 2024
Merged

Fix sphinx warnings #300

merged 5 commits into from
Nov 16, 2024

Conversation

maxrjones
Copy link
Member

This PR auto generates section references and updates the readthedocs CI to not fail on warnings

Closes #299

TomNicholas
TomNicholas reviewed Nov 15, 2024
View reviewed changes
Copy link
Member

@TomNicholas TomNicholas left a comment

Choose a reason for hiding this comment

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

Thanks!

I actually want the docs CI to fail on warnings though - that way we catch them and can make sure nothing is wrong with the released docs whatsoever.

@maxrjones
Copy link
Member Author

I actually want the docs CI to fail on warnings though - that way we catch them and can make sure nothing is wrong with the released docs whatsoever.

Oh sorry! that's what I get for skim reading your original issue. I'll change it to fail on warnings.

@maxrjones
Copy link
Member Author

Good call on the fail on warnings @TomNicholas, that prompted a few more fixes

TomNicholas
TomNicholas approved these changes Nov 15, 2024
View reviewed changes
Copy link
Member

@TomNicholas TomNicholas left a comment

Choose a reason for hiding this comment

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

Thank you @maxrjones !

@TomNicholas TomNicholas added documentation Improvements or additions to documentation CI Continuous Integration labels Nov 15, 2024
@maxrjones maxrjones merged commit 09e4752 into main Nov 16, 2024
11 checks passed
@maxrjones maxrjones deleted the docs branch November 16, 2024 00:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@TomNicholas TomNicholas TomNicholas approved these changes

Assignees
No one assigned
Labels
CI Continuous Integration documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Warnings when building docs
2 participants
@maxrjones @TomNicholas