Enable intersphinx so stdlib references resolve - #624
Open
faresrafat3 wants to merge 1 commit into
Open
faresrafat3 wants to merge 1 commit into
faresrafat3 wants to merge 1 commit into
Conversation
Building the docs with `sphinx-build -n` reports many "py:class reference target not found" warnings for annotations such as collections.abc.Mapping, datetime.datetime and collections.abc.Sequence, because no intersphinx mapping is configured (see python-poetry#192). Add the sphinx.ext.intersphinx extension with the Python inventory. Warnings under -n drop from 55 to 31. The remainder are project-internal references (tomlkit.items.ItemT, tomlkit.container.Container, E, Encoder) that are not part of this change. Fixes python-poetry#192 (partially).
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fixes #192 (partially).
Building the docs with
sphinx-build -nreports many warnings of the form:The cause is that
docs/conf.pyonly enablessphinx.ext.autodoc; with nointersphinx mapping, references to the standard library cannot be resolved.
Change
Adds
sphinx.ext.intersphinxand the Python inventory:Verification
Measured with the same command on the unmodified and modified tree:
All
collections.abc.*anddatetime.*warnings are gone. The remaining 31are project-internal targets (
tomlkit.items.ItemT,tomlkit.container.Container,E,Encoder, and a docutils formattingwarning in the
register_encoderdocstring) which need separate fixes and arenot addressed here.