Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore Fix docs sphinx nitpick warnings - adding intersphinx_mapping #515

Merged

Conversation

leszekhanusz
Copy link
Collaborator

Should fix #501

Note: some class references are still not found because the name of the class computed by sphinx locally does not correspond to the name in the objects.inv file generated by the upstream sphinx documentation.

Package local name upstream name (in objects.inv)
asyncio asyncio.locks.Event asyncio.Event
aiohttp aiohttp.client_reqrep.Fingerprint aiohttp.Fingerprint
aiohttp aiohttp.helpers.BasicAuth aiohttp.BasicAuth
graphql graphql.execution.execute.ExecutionResult graphql.execution.ExecutionResult
graphql Source graphql.language.Source or graphql.language.source.Source
graphql GraphQLSchema graphql.type.GraphQLSchema or graphql.type.schema.GraphQLSchema
multidict multidict._multidict.CIMultiDictProxy multidict.CIMultiDictProxy
multidict multidict._multidict.CIMultiDict multidict.CIMultiDict
multidict multidict._multidict.istr multidict.istr

They've been ignored in the sphinx docs with nitpick_ignore but we should fix this.

Copy link

codecov bot commented Dec 12, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (57ef910) to head (a78ece9).
Report is 8 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff            @@
##            master      #515   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           30        30           
  Lines         3102      3127   +25     
=========================================
+ Hits          3102      3127   +25     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@leszekhanusz leszekhanusz merged commit 483053f into graphql-python:master Dec 12, 2024
15 checks passed
@leszekhanusz leszekhanusz deleted the fix_docs_nitpick_warnings branch December 12, 2024 11:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3.5.0: sphinx warnings reference target not found
1 participant