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

Fix sphinx warnings #934

Closed
wants to merge 0 commits into from
Closed

Fix sphinx warnings #934

wants to merge 0 commits into from

Conversation

ubaumann
Copy link
Contributor

No description provided.

@mjbear
Copy link
Contributor

mjbear commented Aug 14, 2024

Hello @ubaumann
I apologize for not realizing you had a draft PR.
I was curious about the sphinx title so I looked at the modified files. This led me to see a few fixes I put in and raise some questions.

Recently finalized a couple of PRs (#903, #968, #969) for some docs links. I'm wondering if the links should have been to the *.rst files or *.html ... though while creating the PRs I found an instance in one of the files I was editing which swayed me to *.html

I appreciate the conversation and guidance!

@ubaumann
Copy link
Contributor Author

Hello @ubaumann I apologize for not realizing you had a draft PR. I was curious about the sphinx title so I looked at the modified files. This led me to see a few fixes I put in and raise some questions.

No worries, I honestly forgot about this pull request.

The idea was to use the "-W" flag for the build process. With this flag, Sphinx build will fail when warnings are present, and we will find issues faster in the future.

If you feel up to it, you can take over and create a pull request, and we can close this one.

make docs SPHINXOPTS="-W"

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

Successfully merging this pull request may close these issues.

2 participants