Closed kloczek closed 2 years ago
https://github.com/HypothesisWorks/hypothesis/pull/3323#issuecomment-1129577925: If you're in a docs mood, you could even take a look at https://github.com/HypothesisWorks/hypothesis/issues/3345 - I think maybe we just need to remove the
python:
(or whichever project) prefix in these? Just reproducing with sphinx-build in nitpicky mode would be a great start.
From https://github.com/HypothesisWorks/hypothesis/pull/3347#issue-1239648335: looks like those are Python specific cross references (doc) which I think should be py:
for the Python domain (doc)?
Also, thereβs a bunch of pygrep-hooks for pre-commit that might be useful here?
I have no idea. +3 weeks ago I've started moving away from use setuptools<>sphinx integration (python setup.py build_sphins
) to use straight sphinx-build
command. All because more and more modulea re no longer using setuptools and it was necessary to find some generic method building documentation for all python mopdule packaging procedure.
Since I've started that task I'm non looking on fixing those issuess but only to create tickets providing only refferences to other tickets which maintaioners already sorted out that kind of issues
[tkloczko@devel-g2v SPECS]$ grep py3_build_sphinx_man python-* | wc -l; grep sphinx_build_man python-* | wc -l; ls -1 python-*| wc -l
141
391
932
Tose numbers are: 932 -> total number of packages with python modules, 391 -> number of modules which have been already migrated to use sphinx-build
, 141 -> nuber of packages which still needs to be reviewe, patched, and if anything is wrong ticket needs to be created π
Probably when I'll migrate all that I'll start helping maintainers to resolve those issues.
So far looking on my other stats I've created about 110 tickets like that (yeah .. I know I'm github spammer π ).
Until I'll not finish above task .. sorry I'm just only messanger π
#3323 (comment): If you're in a docs mood, you could even take a look at #3345 - I think maybe we just need to remove the
python:
(or whichever project) prefix in these? Just reproducing with sphinx-build in nitpicky mode would be a great start.From #3347 (comment): looks like those are Python specific cross references (doc) which I think should be
py:
for the Python domain (doc)?
No, the domain is fine here (that determines what kind of link to create); I think the problem is that recent changes to InterSphinx mean that if we include the project name inside the backticks, then in -n
nitpicky mode we get a warning.
Also, thereβs a bunch of pygrep-hooks for pre-commit that might be useful here?
I'd rather just add the -n
argument to our sphinx-build
invocation, though git grep
and replace is probably the best approach for the one-time big fix π
Probably when I'll migrate all that I'll start helping maintainers to resolve those issues. So far looking on my other stats I've created about 110 tickets like that (yeah .. I know I'm github spammer π ). Until I'll not finish above task .. sorry I'm just only messanger π
Hey, no spam here π₯° - your report was clear, identified the (low) severity of the issue, showed how to fix it, and gave enough context that we could decide what to do. In this case we want to fix it, but I often think about optimizing issues to be easy to close - e.g. by providing enough information up front that the maintainer can easily decide what the next steps should be. I would recommend a spell-checker though, some people get pretty picky about that π
I would recommend a spell-checker though, some people get pretty picky about that π
Sorry about that π
I haven't been able to reproduce this - maybe Sphinx isn't finding the intersphinx
inventories for some reason?
Two more examples of fixing similar issues https://github.com/latchset/jwcrypto/pull/289 https://github.com/RDFLib/rdflib-sqlalchemy/issues/95
Closing this because we already use nitpicky mode in CI, and don't claim to support other ways of running it:
Closing this because we already use nitpicky mode in CI, and don't claim to support other ways of running it:
Moment ,, so you not been able to reproduce those warnings? π€
On building my packages I'm using
sphinx-build
command with-n
switch which shows warmings about missing references. These are not critical issues. Here is the output with warnings:You can peak on fixes that kind of issues in other projects https://github.com/latchset/jwcrypto/pull/289 https://github.com/click-contrib/sphinx-click/commit/abc31069