using httpdomain with intersphinx
Opened this issue · 0 comments
Hi,
maybe it's a mis usage from my side, but I can't get httpdoamain to properly work with intersphinx.
The issue I have is if I put an intersphinx reference to a httpdomain node without making it explicit, the WARNING: Cannot resolve reference message is triggered (even if the reference resolution actually worked ok).
This is annoying since we do run sphinx with -W in our CI, and currently we are hacking the build system inserting a custom log filter to prevent these messages to generate an error (because of the -W), and I'd like to get rid of this hack.
I've attached a minimal project to reproduce the issue.
The useful part of the index.rst file is
This is ok: :external:http:get:`/api/1/resolve/(swhid)/`.
This is not: :http:get:`/api/1/resolve/(swhid)/`.
Building the doc from there, you should see:
test-httpdomain$ make html
Running Sphinx v7.2.6
making output directory... done
loading intersphinx inventory from https://docs.softwareheritage.org/objects.inv...
building [mo]: targets for 0 po files that are out of date
writing output...
building [html]: targets for 1 source files that are out of date
updating environment: [new config] 1 added, 0 changed, 0 removed
reading sources... [100%] index
looking for now-outdated files... none found
pickling environment... done
checking consistency... done
preparing documents... done
copying assets... copying static files... done
copying extra files... done
done
writing output... [100%] index
/home/ddouard/tmp/test-httpdomain/index.rst:9: WARNING: Cannot resolve reference to <#text: 'GET /api/1/resolve/(swhid)/'>
generating indices... genindex done
writing additional pages... search done
dumping search index in English (code: en)... done
dumping object inventory... done
build succeeded, 1 warning.
The HTML pages are in _build/html.
Notice the WARNING being generated for the non-explicit external reference.