nornir-automation / nornir

Pluggable multi-threaded framework with inventory management to help operate collections of devices
https://nornir.readthedocs.io/
Apache License 2.0
1.39k stars 235 forks source link

Fix sphinx warnings #934

Closed ubaumann closed 1 month ago

mjbear commented 1 month ago

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 commented 1 month ago

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"