Mention priority 0 and 2

bskinn / sphobjinv

Toolkit for manipulation and inspection of Sphinx objects.inv files

https://sphobjinv.readthedocs.io

MIT License

78 stars 7 forks source link

Mention priority 0 and 2 #284

Closed pawamoy closed 10 months ago

pawamoy commented 10 months ago

Is the PR a fix or a feature? Docs change.

Describe the changes in the PR I simply add a mention of what Sphinx expects for priorities other than 1 and -1. Just reading the current docs led to me think 0 would be low priority, and then 2, 3, 4, etc. higher priorities. I'm not sure if priorities higher than 2 make sense to Sphinx :confused:

Does this PR close any issues? No.

Does the PR change/update the following, if relevant?

[x] Documentation
[ ] Tests
[ ] CHANGELOG

bskinn commented 10 months ago

Thanks for this, @pawamoy!

One thing -- the PR is opened against stable as base branch, when it needs to be against main. Can you rebase?

I'll look into the linkcheck failure...

bskinn commented 10 months ago

Looks like the Arch Linux reference in index.rst needs to be updated to https://archlinux.org/packages/extra/any/python-sphobjinv/

Could you fix that in this PR?

pawamoy commented 10 months ago

Sure, done :slightly_smiling_face:

bskinn commented 10 months ago

All good now, thanks @pawamoy!