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

Fix Sphinx warning about "request" cross-reference #322

Open
twm opened this issue Jan 25, 2021 · 0 comments
Open

Fix Sphinx warning about "request" cross-reference #322

twm opened this issue Jan 25, 2021 · 0 comments
Labels

Comments

@twm
Copy link
Contributor

twm commented Jan 25, 2021

Sphinx, as run by tox -e docs, generates this warning:

/home/runner/work/treq/treq/docs/api.rst:80: WARNING: more than one target found for cross-reference 'request': treq.request, treq.client.HTTPClient.request, treq.testing.treq.testing.StubTreq.request, treq.testing.RequestTraversalAgent.request

This warning disappears if line 70 of docs/api.rst is deleted (note that this is not the same line the warning is reported on!):

    :ivar request: See :attr:`IResponse.request <twisted.web.iweb.IResponse.request>`

The warning seems to originate in the :ivar request: bit. Removing the :attr: reference doesn't fix it.

Once this has been resolved, configure Sphinx to fail on warnings as Adi suggests.

@twm twm added the bug label Jan 25, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

1 participant