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

0.9.1: sphinx warnings #310

Open
kloczek opened this issue Jun 4, 2021 · 5 comments
Open

0.9.1: sphinx warnings #310

kloczek opened this issue Jun 4, 2021 · 5 comments

Comments

@kloczek
Copy link

kloczek commented Jun 4, 2021

+ /usr/bin/python3 setup.py build_sphinx -b man
running build_sphinx
Running Sphinx v4.0.2
making output directory... done
loading intersphinx inventory from https://docs.python.org/objects.inv...
intersphinx inventory has moved: https://docs.python.org/objects.inv -> https://docs.python.org/3/objects.inv
building [mo]: targets for 0 po files that are out of date
building [man]: all manpages
updating environment: [new config] 14 added, 0 changed, 0 removed
reading sources... [100%] user-agent
/home/tkloczko/rpmbuild/BUILD/toolbelt-0.9.1/requests_toolbelt/sessions.py:docstring of requests_toolbelt.sessions.BaseUrlSession:1: WARNING: duplicate object description of requests_toolbelt.sessions.BaseUrlSession, other instance in sessions, use :noindex: for one of them
/home/tkloczko/rpmbuild/BUILD/toolbelt-0.9.1/requests_toolbelt/sessions.py:docstring of requests_toolbelt.sessions.BaseUrlSession.create_url:1: WARNING: duplicate object description of requests_toolbelt.sessions.BaseUrlSession.create_url, other instance in sessions, use :noindex: for one of them
/home/tkloczko/rpmbuild/BUILD/toolbelt-0.9.1/requests_toolbelt/sessions.py:docstring of requests_toolbelt.sessions.BaseUrlSession.request:1: WARNING: duplicate object description of requests_toolbelt.sessions.BaseUrlSession.request, other instance in sessions, use :noindex: for one of them
looking for now-outdated files... none found
pickling environment... done
checking consistency... done
writing... python-requests_toolbelt.3 { user contributing adapters authentication deprecated downloadutils dumputils formdata exceptions sessions threading uploading-data user-agent } done
build succeeded, 3 warnings.
@kloczek
Copy link
Author

kloczek commented May 1, 2023

Just FTR just released 1.0.0 warning

+ /usr/bin/sphinx-build -n -T -b man docs build/sphinx/man
Running Sphinx v6.2.1
making output directory... done
WARNING: The pre-Sphinx 1.0 'intersphinx_mapping' format is deprecated and will be removed in Sphinx 8. Update to the current format as described in the documentation. Hint: "intersphinx_mapping = {'<name>': ('https://docs.python.org/', None)}".https://www.sphinx-doc.org/en/master/usage/extensions/intersphinx.html#confval-intersphinx_mapping
loading intersphinx inventory from https://docs.python.org/objects.inv...
intersphinx inventory has moved: https://docs.python.org/objects.inv -> https://docs.python.org/3/objects.inv
building [mo]: targets for 0 po files that are out of date
writing output...
building [man]: all manpages
updating environment: [new config] 14 added, 0 changed, 0 removed
reading sources... [100%] user-agent
/home/tkloczko/rpmbuild/BUILD/toolbelt-1.0.0/requests_toolbelt/sessions.py:docstring of requests_toolbelt.sessions.BaseUrlSession:1: WARNING: duplicate object description of requests_toolbelt.sessions.BaseUrlSession, other instance in sessions, use :noindex: for one of them
/home/tkloczko/rpmbuild/BUILD/toolbelt-1.0.0/requests_toolbelt/sessions.py:docstring of requests_toolbelt.sessions.BaseUrlSession.create_url:1: WARNING: duplicate object description of requests_toolbelt.sessions.BaseUrlSession.create_url, other instance in sessions, use :noindex: for one of them
/home/tkloczko/rpmbuild/BUILD/toolbelt-1.0.0/requests_toolbelt/sessions.py:docstring of requests_toolbelt.sessions.BaseUrlSession.prepare_request:1: WARNING: duplicate object description of requests_toolbelt.sessions.BaseUrlSession.prepare_request, other instance in sessions, use :noindex: for one of them
/home/tkloczko/rpmbuild/BUILD/toolbelt-1.0.0/requests_toolbelt/sessions.py:docstring of requests_toolbelt.sessions.BaseUrlSession.request:1: WARNING: duplicate object description of requests_toolbelt.sessions.BaseUrlSession.request, other instance in sessions, use :noindex: for one of them
looking for now-outdated files... none found
pickling environment... done
checking consistency... done
writing... python-requests_toolbelt.3 { user contributing adapters authentication deprecated downloadutils dumputils formdata exceptions sessions threading uploading-data user-agent } /home/tkloczko/rpmbuild/BUILD/toolbelt-1.0.0/docs/adapters.rst:6: WARNING: py:mod reference target not found: requests_toolbelt.adapters
/home/tkloczko/rpmbuild/BUILD/toolbelt-1.0.0/docs/authentication.rst:16: WARNING: py:mod reference target not found: requests_toolbelt.auth
/home/tkloczko/rpmbuild/BUILD/toolbelt-1.0.0/requests_toolbelt/auth/handler.py:docstring of requests_toolbelt.auth.handler.AuthHandler:29: WARNING: py:class reference target not found: requests.auth.HTTPDigestAuth
/home/tkloczko/rpmbuild/BUILD/toolbelt-1.0.0/docs/deprecated.rst:6: WARNING: py:mod reference target not found: requests.utils
/home/tkloczko/rpmbuild/BUILD/toolbelt-1.0.0/requests_toolbelt/utils/deprecated.py:docstring of requests_toolbelt.utils.deprecated.get_unicode_from_response:1: WARNING: py:class reference target not found: requests.models.Response
/home/tkloczko/rpmbuild/BUILD/toolbelt-1.0.0/requests_toolbelt/downloadutils/stream.py:docstring of requests_toolbelt.downloadutils.stream.stream_response_to_file:1: WARNING: py:class reference target not found: requests.models.Response
/home/tkloczko/rpmbuild/BUILD/toolbelt-1.0.0/requests_toolbelt/downloadutils/stream.py:docstring of requests_toolbelt.downloadutils.stream.stream_response_to_file:80: WARNING: py:meth reference target not found: write
/home/tkloczko/rpmbuild/BUILD/toolbelt-1.0.0/requests_toolbelt/downloadutils/tee.py:docstring of requests_toolbelt.downloadutils.tee.tee:1: WARNING: py:class reference target not found: requests.Response
/home/tkloczko/rpmbuild/BUILD/toolbelt-1.0.0/requests_toolbelt/downloadutils/tee.py:docstring of requests_toolbelt.downloadutils.tee.tee:1: WARNING: py:class reference target not found: file
/home/tkloczko/rpmbuild/BUILD/toolbelt-1.0.0/requests_toolbelt/downloadutils/tee.py:docstring of requests_toolbelt.downloadutils.tee.tee_to_bytearray:8: WARNING: py:meth reference target not found: bytearray.extend
/home/tkloczko/rpmbuild/BUILD/toolbelt-1.0.0/requests_toolbelt/downloadutils/tee.py:docstring of requests_toolbelt.downloadutils.tee.tee_to_bytearray:1: WARNING: py:class reference target not found: requests.Response
/home/tkloczko/rpmbuild/BUILD/toolbelt-1.0.0/requests_toolbelt/downloadutils/tee.py:docstring of requests_toolbelt.downloadutils.tee.tee_to_file:1: WARNING: py:class reference target not found: requests.Response
/home/tkloczko/rpmbuild/BUILD/toolbelt-1.0.0/docs/dumputils.rst:6: WARNING: py:mod reference target not found: requests_toolbelt.utils.dump
/home/tkloczko/rpmbuild/BUILD/toolbelt-1.0.0/requests_toolbelt/utils/dump.py:docstring of requests_toolbelt.utils.dump.dump_all:18: WARNING: py:class reference target not found: requests.Response
/home/tkloczko/rpmbuild/BUILD/toolbelt-1.0.0/requests_toolbelt/utils/dump.py:docstring of requests_toolbelt.utils.dump.dump_response:17: WARNING: py:class reference target not found: requests.Response
/home/tkloczko/rpmbuild/BUILD/toolbelt-1.0.0/requests_toolbelt/exceptions.py:docstring of requests_toolbelt.exceptions.StreamingError:1: WARNING: py:mod reference target not found: requests_toolbelt.downloadutils.stream
/home/tkloczko/rpmbuild/BUILD/toolbelt-1.0.0/requests_toolbelt/sessions.py:docstring of requests_toolbelt.sessions.BaseUrlSession:49: WARNING: py:mod reference target not found: urllib.parse.urljoin
/home/tkloczko/rpmbuild/BUILD/toolbelt-1.0.0/requests_toolbelt/sessions.py:docstring of requests_toolbelt.sessions.BaseUrlSession:49: WARNING: py:mod reference target not found: urllib.parse.urljoin
/home/tkloczko/rpmbuild/BUILD/toolbelt-1.0.0/docs/threading.rst:28: WARNING: py:class reference target not found: requests.Response
/home/tkloczko/rpmbuild/BUILD/toolbelt-1.0.0/docs/threading.rst:75: WARNING: py:meth reference target not found: Pool.exceptions
/home/tkloczko/rpmbuild/BUILD/toolbelt-1.0.0/docs/threading.rst:113: WARNING: py:class reference target not found: Pool
/home/tkloczko/rpmbuild/BUILD/toolbelt-1.0.0/docs/threading.rst:133: WARNING: py:class reference target not found: requests.Sesssion
/home/tkloczko/rpmbuild/BUILD/toolbelt-1.0.0/docs/threading.rst:133: WARNING: py:class reference target not found: requests.Session
/home/tkloczko/rpmbuild/BUILD/toolbelt-1.0.0/requests_toolbelt/threaded/__init__.py:docstring of requests_toolbelt.threaded:33: WARNING: py:class reference target not found: requests.Session
/home/tkloczko/rpmbuild/BUILD/toolbelt-1.0.0/requests_toolbelt/threaded/pool.py:docstring of requests_toolbelt.threaded.pool.Pool:1: WARNING: py:class reference target not found: collections.Callable
/home/tkloczko/rpmbuild/BUILD/toolbelt-1.0.0/requests_toolbelt/threaded/pool.py:docstring of requests_toolbelt.threaded.pool.Pool:1: WARNING: py:class reference target not found: collections.Callable
/home/tkloczko/rpmbuild/BUILD/toolbelt-1.0.0/requests_toolbelt/threaded/pool.py:docstring of requests_toolbelt.threaded.pool.Pool:1: WARNING: py:class reference target not found: requests.Session
/home/tkloczko/rpmbuild/BUILD/toolbelt-1.0.0/requests_toolbelt/threaded/pool.py:docstring of requests_toolbelt.threaded.pool.Pool.from_exceptions:1: WARNING: py:class reference target not found: iterable
/home/tkloczko/rpmbuild/BUILD/toolbelt-1.0.0/requests_toolbelt/threaded/pool.py:docstring of requests_toolbelt.threaded.pool.Pool.from_urls:1: WARNING: py:class reference target not found: iterable
/home/tkloczko/rpmbuild/BUILD/toolbelt-1.0.0/requests_toolbelt/multipart/encoder.py:docstring of requests_toolbelt.multipart.encoder.MultipartEncoder:47: WARNING: py:mod reference target not found: httplib
/home/tkloczko/rpmbuild/BUILD/toolbelt-1.0.0/requests_toolbelt/multipart/encoder.py:docstring of requests_toolbelt.multipart.encoder.MultipartEncoder:47: WARNING: py:mod reference target not found: httplib
/home/tkloczko/rpmbuild/BUILD/toolbelt-1.0.0/docs/uploading-data.rst:117: WARNING: py:class reference target not found: requests.toolbelt.streaming_iterator.StreamingIterator
/home/tkloczko/rpmbuild/BUILD/toolbelt-1.0.0/docs/user-agent.rst:65: WARNING: py:func reference target not found: requests_toolbelt.utils.user_agent.user_agent
/home/tkloczko/rpmbuild/BUILD/toolbelt-1.0.0/requests_toolbelt/utils/user_agent.py:docstring of requests_toolbelt.utils.user_agent.UserAgentBuilder:1: WARNING: py:func reference target not found: user_agent
/home/tkloczko/rpmbuild/BUILD/toolbelt-1.0.0/requests_toolbelt/utils/user_agent.py:docstring of requests_toolbelt.utils.user_agent.UserAgentBuilder:3: WARNING: py:func reference target not found: user_agent
done
build succeeded, 40 warnings.

You can peak on fixes that kind of issues in other projects
RDFLib/rdflib-sqlalchemy#95
RDFLib/rdflib#2036
click-contrib/sphinx-click@abc31069
frostming/unearth#14
jaraco/cssutils#21
latchset/jwcrypto#289
latchset/jwcrypto#289
pypa/distlib@98b9b89f
pywbem/pywbem#2895
sissaschool/elementpath@bf869d9e
sissaschool/xmlschema@42ea98f2
sqlalchemy/sqlalchemy@5e88e6e8

@pquentin
Copy link
Contributor

pquentin commented May 1, 2023

Thanks, I would accept a pull request that 1/ fixes any warnings happening when running tox -e docs and 2/ enables nitpicky mode.

@kloczek
Copy link
Author

kloczek commented May 1, 2023

I'm interested only roff output (man pages) which is not affected by those warnings
This issue affects .html, .qch and probably .pdf output as well there is no olinks and only some routines names are highlighted).
However during packaging I'm tring to flag all issues which I'm able to spot. 😋

Really sorry but I'm at least for now realy busu with other issues 😞

@pquentin
Copy link
Contributor

pquentin commented May 1, 2023

No worries, I was saying that in general, not specifically for you.

@kloczek
Copy link
Author

kloczek commented May 1, 2023

Nevertheless those links which I've dropped are results of my other tickets so with that it will be easier to fix that if someone will find some time to sort that out 😋

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

No branches or pull requests

2 participants