-
Notifications
You must be signed in to change notification settings - Fork 29
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
4.9.0: sphinx warnings reference target not found
#173
Comments
The Sphinx configuration has changed dramatically and this is no longer applicable. |
Just checked master and still that patch is not added and still I see he same warnings + /usr/bin/sphinx-build -n -T -b man docs build/sphinx/man
Running Sphinx v8.0.2
loading translations [en]... done
making output directory... done
WARNING: html_static_path entry '_static' does not exist
building [mo]: targets for 0 po files that are out of date
writing output...
building [man]: all manpages
updating environment: [new config] 10 added, 0 changed, 0 removed
reading sources... [100%] using
WARNING: autodoc: failed to import class 'mapping.PersistentMapping' from module 'persistent'; the following exception was raised:
No module named 'persistent' [autodoc.import_object]
WARNING: autodoc: failed to import class 'list.PersistentList' from module 'persistent'; the following exception was raised:
No module named 'persistent' [autodoc.import_object]
WARNING: autodoc: failed to import module 'interfaces' from module 'persistent'; the following exception was raised:
No module named 'persistent' [autodoc.import_object]
WARNING: autodoc: failed to import class 'Persistent' from module 'persistent'; the following exception was raised:
No module named 'persistent' [autodoc.import_object]
looking for now-outdated files... none found
pickling environment... done
checking consistency... done
writing... python-persistent.3 { using api api/interfaces api/collections api/attributes api/pickling api/cache changes glossary } /home/tkloczko/rpmbuild/BUILD/persistent-6.0/docs/index.rst:1: WARNING: py:mod reference target not found: persistent [ref.mod]
/home/tkloczko/rpmbuild/BUILD/persistent-6.0/docs/using.rst:2: WARNING: py:mod reference target not found: persistent [ref.mod]
/home/tkloczko/rpmbuild/BUILD/persistent-6.0/docs/using.rst:6: WARNING: py:class reference target not found: persistent.Persistent [ref.class]
/home/tkloczko/rpmbuild/BUILD/persistent-6.0/docs/using.rst:9: WARNING: py:class reference target not found: persistent.Persistent [ref.class]
/home/tkloczko/rpmbuild/BUILD/persistent-6.0/docs/using.rst:88: WARNING: py:attr reference target not found: _p_changed [ref.attr]
/home/tkloczko/rpmbuild/BUILD/persistent-6.0/docs/using.rst:99: WARNING: py:attr reference target not found: _p_state [ref.attr]
/home/tkloczko/rpmbuild/BUILD/persistent-6.0/docs/using.rst:109: WARNING: py:attr reference target not found: _p_jar [ref.attr]
/home/tkloczko/rpmbuild/BUILD/persistent-6.0/docs/using.rst:117: WARNING: py:attr reference target not found: _p_oid [ref.attr]
/home/tkloczko/rpmbuild/BUILD/persistent-6.0/docs/using.rst:210: WARNING: py:class reference target not found: PersistentList [ref.class]
/home/tkloczko/rpmbuild/BUILD/persistent-6.0/docs/using.rst:210: WARNING: py:class reference target not found: PersistentMapping [ref.class]
/home/tkloczko/rpmbuild/BUILD/persistent-6.0/docs/using.rst:219: WARNING: py:meth reference target not found: persistent.Persistent._p_activate [ref.meth]
/home/tkloczko/rpmbuild/BUILD/persistent-6.0/docs/using.rst:219: WARNING: py:meth reference target not found: persistent.Persistent._p_deactivate [ref.meth]
/home/tkloczko/rpmbuild/BUILD/persistent-6.0/docs/using.rst:219: WARNING: py:meth reference target not found: persistent.Persistent._p_invalidate [ref.meth]
/home/tkloczko/rpmbuild/BUILD/persistent-6.0/docs/using.rst:328: WARNING: py:class reference target not found: persistent.Persistent [ref.class]
/home/tkloczko/rpmbuild/BUILD/persistent-6.0/docs/using.rst:412: WARNING: py:class reference target not found: persistent.Persistent [ref.class]
/home/tkloczko/rpmbuild/BUILD/persistent-6.0/docs/using.rst:423: WARNING: py:meth reference target not found: __getattribute__ [ref.meth]
/home/tkloczko/rpmbuild/BUILD/persistent-6.0/docs/using.rst:417: WARNING: py:meth reference target not found: persistent.IPersistent._p_getattr [ref.meth]
/home/tkloczko/rpmbuild/BUILD/persistent-6.0/docs/using.rst:432: WARNING: py:meth reference target not found: __setattr__ [ref.meth]
/home/tkloczko/rpmbuild/BUILD/persistent-6.0/docs/using.rst:426: WARNING: py:meth reference target not found: persistent.IPersistent._p_setattr [ref.meth]
/home/tkloczko/rpmbuild/BUILD/persistent-6.0/docs/using.rst:441: WARNING: py:meth reference target not found: __delattr__ [ref.meth]
/home/tkloczko/rpmbuild/BUILD/persistent-6.0/docs/using.rst:435: WARNING: py:meth reference target not found: persistent.IPersistent._p_delattr [ref.meth]
/home/tkloczko/rpmbuild/BUILD/persistent-6.0/docs/using.rst:446: WARNING: py:meth reference target not found: __getattr__ [ref.meth]
/home/tkloczko/rpmbuild/BUILD/persistent-6.0/docs/api.rst:1: WARNING: py:mod reference target not found: persistent [ref.mod]
/home/tkloczko/rpmbuild/BUILD/persistent-6.0/docs/api/interfaces.rst:1: WARNING: py:mod reference target not found: persistent.interfaces [ref.mod]
/home/tkloczko/rpmbuild/BUILD/persistent-6.0/docs/api/interfaces.rst:21: WARNING: py:class reference target not found: IPersistent [ref.class]
/home/tkloczko/rpmbuild/BUILD/persistent-6.0/docs/api/attributes.rst:4: WARNING: py:meth reference target not found: __getattr__ [ref.meth]
/home/tkloczko/rpmbuild/BUILD/persistent-6.0/docs/api/attributes.rst:46: WARNING: py:meth reference target not found: __getattr__ [ref.meth]
/home/tkloczko/rpmbuild/BUILD/persistent-6.0/docs/api/attributes.rst:52: WARNING: py:meth reference target not found: __getattribute__ [ref.meth]
/home/tkloczko/rpmbuild/BUILD/persistent-6.0/docs/api/attributes.rst:52: WARNING: py:meth reference target not found: __setattr__ [ref.meth]
/home/tkloczko/rpmbuild/BUILD/persistent-6.0/docs/api/attributes.rst:52: WARNING: py:meth reference target not found: __delattr__ [ref.meth]
/home/tkloczko/rpmbuild/BUILD/persistent-6.0/docs/api/attributes.rst:68: WARNING: py:meth reference target not found: __getattribute__` [ref.meth]
/home/tkloczko/rpmbuild/BUILD/persistent-6.0/docs/api/attributes.rst:71: WARNING: py:meth reference target not found: __getattribute__ [ref.meth]
/home/tkloczko/rpmbuild/BUILD/persistent-6.0/docs/api/attributes.rst:128: WARNING: py:meth reference target not found: __setattr__` [ref.meth]
/home/tkloczko/rpmbuild/BUILD/persistent-6.0/docs/api/attributes.rst:131: WARNING: py:meth reference target not found: __setattr__ [ref.meth]
/home/tkloczko/rpmbuild/BUILD/persistent-6.0/docs/api/attributes.rst:135: WARNING: py:meth reference target not found: __setattr__ [ref.meth]
/home/tkloczko/rpmbuild/BUILD/persistent-6.0/docs/api/attributes.rst:208: WARNING: py:meth reference target not found: __setattr__ [ref.meth]
/home/tkloczko/rpmbuild/BUILD/persistent-6.0/docs/api/attributes.rst:222: WARNING: py:meth reference target not found: __delattr__` [ref.meth]
/home/tkloczko/rpmbuild/BUILD/persistent-6.0/docs/api/attributes.rst:229: WARNING: py:meth reference target not found: __delattr__ [ref.meth]
/home/tkloczko/rpmbuild/BUILD/persistent-6.0/docs/api/attributes.rst:298: WARNING: py:meth reference target not found: __delattr__ [ref.meth]
/home/tkloczko/rpmbuild/BUILD/persistent-6.0/docs/api/pickling.rst:44: WARNING: py:meth reference target not found: __getnewargs__ [ref.meth]
/home/tkloczko/rpmbuild/BUILD/persistent-6.0/docs/api/pickling.rst:44: WARNING: py:meth reference target not found: __getstate__ [ref.meth]
/home/tkloczko/rpmbuild/BUILD/persistent-6.0/docs/api/pickling.rst:44: WARNING: py:meth reference target not found: __setstate__ [ref.meth]
/home/tkloczko/rpmbuild/BUILD/persistent-6.0/docs/api/pickling.rst:76: WARNING: py:attr reference target not found: __slots__ [ref.attr]
/home/tkloczko/rpmbuild/BUILD/persistent-6.0/docs/api/pickling.rst:125: WARNING: py:class reference target not found: persistent.Persistent [ref.class]
/home/tkloczko/rpmbuild/BUILD/persistent-6.0/docs/api/pickling.rst:125: WARNING: py:attr reference target not found: __slots [ref.attr]
/home/tkloczko/rpmbuild/BUILD/persistent-6.0/docs/api/cache.rst:7: WARNING: py:class reference target not found: persistent.interfaces.IPeristent [ref.class]
/home/tkloczko/rpmbuild/BUILD/persistent-6.0/docs/api/cache.rst:11: WARNING: py:meth reference target not found: _p_deactivate [ref.meth]
/home/tkloczko/rpmbuild/BUILD/persistent-6.0/docs/api/cache.rst:11: WARNING: py:meth reference target not found: _p_invalidate [ref.meth]
/home/tkloczko/rpmbuild/BUILD/persistent-6.0/docs/api/cache.rst:14: WARNING: py:attr reference target not found: _p_changed [ref.attr]
/home/tkloczko/rpmbuild/BUILD/persistent-6.0/docs/api/cache.rst:14: WARNING: py:meth reference target not found: _p_deactivate [ref.meth]
/home/tkloczko/rpmbuild/BUILD/persistent-6.0/docs/api/cache.rst:16: WARNING: py:attr reference target not found: _p_changed [ref.attr]
/home/tkloczko/rpmbuild/BUILD/persistent-6.0/docs/api/cache.rst:16: WARNING: py:meth reference target not found: _p_invalidate [ref.meth]
/home/tkloczko/rpmbuild/BUILD/persistent-6.0/docs/api/cache.rst:33: WARNING: py:meth reference target not found: new_ghost [ref.meth]
done
build succeeded, 58 warnings. All because none changes abut typing has been added. |
On top of that looks like with what is on master pytest is failing + PYTHONPATH=/home/tkloczko/rpmbuild/BUILDROOT/python-persistent-6.0-2.fc37.x86_64/usr/lib64/python3.10/site-packages:/home/tkloczko/rpmbuild/BUILDROOT/python-persistent-6.0-2.fc37.x86_64/usr/lib/python3.10/site-packages
+ /usr/bin/pytest -ra -m 'not network'
==================================================================================== test session starts ====================================================================================
platform linux -- Python 3.10.14, pytest-8.2.2, pluggy-1.5.0
rootdir: /home/tkloczko/rpmbuild/BUILD/persistent-6.0
plugins: mock-3.14.0
collected 0 items / 10 errors
========================================================================================== ERRORS ===========================================================================================
___________________________________________________________________ ERROR collecting src/persistent/tests/test__compat.py ___________________________________________________________________
ImportError while importing test module '/home/tkloczko/rpmbuild/BUILD/persistent-6.0/src/persistent/tests/test__compat.py'.
Hint: make sure your test modules/packages have valid Python names.
Traceback:
/usr/lib64/python3.10/importlib/__init__.py:126: in import_module
return _bootstrap._gcd_import(name[level:], package, level)
src/persistent/__init__.py:36: in <module>
from persistent import picklecache as _picklecache
src/persistent/picklecache.py:29: in <module>
from persistent.ring import Ring
src/persistent/ring.py:18: in <module>
from persistent import _ring
E ImportError: cannot import name '_ring' from partially initialized module 'persistent' (most likely due to a circular import) (/home/tkloczko/rpmbuild/BUILD/persistent-6.0/src/persistent/__init__.py)
________________________________________________________________ ERROR collecting src/persistent/tests/test_compile_flags.py ________________________________________________________________
ImportError while importing test module '/home/tkloczko/rpmbuild/BUILD/persistent-6.0/src/persistent/tests/test_compile_flags.py'.
Hint: make sure your test modules/packages have valid Python names.
Traceback:
/usr/lib64/python3.10/importlib/__init__.py:126: in import_module
return _bootstrap._gcd_import(name[level:], package, level)
src/persistent/__init__.py:36: in <module>
from persistent import picklecache as _picklecache
src/persistent/picklecache.py:29: in <module>
from persistent.ring import Ring
src/persistent/ring.py:18: in <module>
from persistent import _ring
E ImportError: cannot import name '_ring' from partially initialized module 'persistent' (most likely due to a circular import) (/home/tkloczko/rpmbuild/BUILD/persistent-6.0/src/persistent/__init__.py)
____________________________________________________________________ ERROR collecting src/persistent/tests/test_docs.py _____________________________________________________________________
ImportError while importing test module '/home/tkloczko/rpmbuild/BUILD/persistent-6.0/src/persistent/tests/test_docs.py'.
Hint: make sure your test modules/packages have valid Python names.
Traceback:
/usr/lib64/python3.10/importlib/__init__.py:126: in import_module
return _bootstrap._gcd_import(name[level:], package, level)
src/persistent/__init__.py:36: in <module>
from persistent import picklecache as _picklecache
src/persistent/picklecache.py:29: in <module>
from persistent.ring import Ring
src/persistent/ring.py:18: in <module>
from persistent import _ring
E ImportError: cannot import name '_ring' from partially initialized module 'persistent' (most likely due to a circular import) (/home/tkloczko/rpmbuild/BUILD/persistent-6.0/src/persistent/__init__.py)
____________________________________________________________________ ERROR collecting src/persistent/tests/test_list.py _____________________________________________________________________
ImportError while importing test module '/home/tkloczko/rpmbuild/BUILD/persistent-6.0/src/persistent/tests/test_list.py'.
Hint: make sure your test modules/packages have valid Python names.
Traceback:
/usr/lib64/python3.10/importlib/__init__.py:126: in import_module
return _bootstrap._gcd_import(name[level:], package, level)
src/persistent/__init__.py:36: in <module>
from persistent import picklecache as _picklecache
src/persistent/picklecache.py:29: in <module>
from persistent.ring import Ring
src/persistent/ring.py:18: in <module>
from persistent import _ring
E ImportError: cannot import name '_ring' from partially initialized module 'persistent' (most likely due to a circular import) (/home/tkloczko/rpmbuild/BUILD/persistent-6.0/src/persistent/__init__.py)
___________________________________________________________________ ERROR collecting src/persistent/tests/test_mapping.py ___________________________________________________________________
ImportError while importing test module '/home/tkloczko/rpmbuild/BUILD/persistent-6.0/src/persistent/tests/test_mapping.py'.
Hint: make sure your test modules/packages have valid Python names.
Traceback:
/usr/lib64/python3.10/importlib/__init__.py:126: in import_module
return _bootstrap._gcd_import(name[level:], package, level)
src/persistent/__init__.py:36: in <module>
from persistent import picklecache as _picklecache
src/persistent/picklecache.py:29: in <module>
from persistent.ring import Ring
src/persistent/ring.py:18: in <module>
from persistent import _ring
E ImportError: cannot import name '_ring' from partially initialized module 'persistent' (most likely due to a circular import) (/home/tkloczko/rpmbuild/BUILD/persistent-6.0/src/persistent/__init__.py)
_________________________________________________________________ ERROR collecting src/persistent/tests/test_persistence.py _________________________________________________________________
ImportError while importing test module '/home/tkloczko/rpmbuild/BUILD/persistent-6.0/src/persistent/tests/test_persistence.py'.
Hint: make sure your test modules/packages have valid Python names.
Traceback:
/usr/lib64/python3.10/importlib/__init__.py:126: in import_module
return _bootstrap._gcd_import(name[level:], package, level)
src/persistent/__init__.py:36: in <module>
from persistent import picklecache as _picklecache
src/persistent/picklecache.py:29: in <module>
from persistent.ring import Ring
src/persistent/ring.py:18: in <module>
from persistent import _ring
E ImportError: cannot import name '_ring' from partially initialized module 'persistent' (most likely due to a circular import) (/home/tkloczko/rpmbuild/BUILD/persistent-6.0/src/persistent/__init__.py)
_________________________________________________________________ ERROR collecting src/persistent/tests/test_picklecache.py _________________________________________________________________
ImportError while importing test module '/home/tkloczko/rpmbuild/BUILD/persistent-6.0/src/persistent/tests/test_picklecache.py'.
Hint: make sure your test modules/packages have valid Python names.
Traceback:
/usr/lib64/python3.10/importlib/__init__.py:126: in import_module
return _bootstrap._gcd_import(name[level:], package, level)
src/persistent/__init__.py:36: in <module>
from persistent import picklecache as _picklecache
src/persistent/picklecache.py:29: in <module>
from persistent.ring import Ring
src/persistent/ring.py:18: in <module>
from persistent import _ring
E ImportError: cannot import name '_ring' from partially initialized module 'persistent' (most likely due to a circular import) (/home/tkloczko/rpmbuild/BUILD/persistent-6.0/src/persistent/__init__.py)
____________________________________________________________________ ERROR collecting src/persistent/tests/test_ring.py _____________________________________________________________________
ImportError while importing test module '/home/tkloczko/rpmbuild/BUILD/persistent-6.0/src/persistent/tests/test_ring.py'.
Hint: make sure your test modules/packages have valid Python names.
Traceback:
/usr/lib64/python3.10/importlib/__init__.py:126: in import_module
return _bootstrap._gcd_import(name[level:], package, level)
src/persistent/__init__.py:36: in <module>
from persistent import picklecache as _picklecache
src/persistent/picklecache.py:29: in <module>
from persistent.ring import Ring
src/persistent/ring.py:18: in <module>
from persistent import _ring
E ImportError: cannot import name '_ring' from partially initialized module 'persistent' (most likely due to a circular import) (/home/tkloczko/rpmbuild/BUILD/persistent-6.0/src/persistent/__init__.py)
__________________________________________________________________ ERROR collecting src/persistent/tests/test_timestamp.py __________________________________________________________________
ImportError while importing test module '/home/tkloczko/rpmbuild/BUILD/persistent-6.0/src/persistent/tests/test_timestamp.py'.
Hint: make sure your test modules/packages have valid Python names.
Traceback:
/usr/lib64/python3.10/importlib/__init__.py:126: in import_module
return _bootstrap._gcd_import(name[level:], package, level)
src/persistent/__init__.py:36: in <module>
from persistent import picklecache as _picklecache
src/persistent/picklecache.py:29: in <module>
from persistent.ring import Ring
src/persistent/ring.py:18: in <module>
from persistent import _ring
E ImportError: cannot import name '_ring' from partially initialized module 'persistent' (most likely due to a circular import) (/home/tkloczko/rpmbuild/BUILD/persistent-6.0/src/persistent/__init__.py)
____________________________________________________________________ ERROR collecting src/persistent/tests/test_wref.py _____________________________________________________________________
ImportError while importing test module '/home/tkloczko/rpmbuild/BUILD/persistent-6.0/src/persistent/tests/test_wref.py'.
Hint: make sure your test modules/packages have valid Python names.
Traceback:
/usr/lib64/python3.10/importlib/__init__.py:126: in import_module
return _bootstrap._gcd_import(name[level:], package, level)
src/persistent/__init__.py:36: in <module>
from persistent import picklecache as _picklecache
src/persistent/picklecache.py:29: in <module>
from persistent.ring import Ring
src/persistent/ring.py:18: in <module>
from persistent import _ring
E ImportError: cannot import name '_ring' from partially initialized module 'persistent' (most likely due to a circular import) (/home/tkloczko/rpmbuild/BUILD/persistent-6.0/src/persistent/__init__.py)
================================================================================== short test summary info ==================================================================================
ERROR src/persistent/tests/test__compat.py
ERROR src/persistent/tests/test_compile_flags.py
ERROR src/persistent/tests/test_docs.py
ERROR src/persistent/tests/test_list.py
ERROR src/persistent/tests/test_mapping.py
ERROR src/persistent/tests/test_persistence.py
ERROR src/persistent/tests/test_picklecache.py
ERROR src/persistent/tests/test_ring.py
ERROR src/persistent/tests/test_timestamp.py
ERROR src/persistent/tests/test_wref.py
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! Interrupted: 10 errors during collection !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
==================================================================================== 10 errors in 0.29s ===================================================================================== |
The supported way to build the docs is using We do not use |
Those warnings have nothing to do with tox. It is pure result of use |
Gentle ping .. did you try to add to tox.ini --- a/tox.ini
+++ b/tox.ini
@@ -80,5 +80,5 @@
skip_install = false
commands_pre =
commands =
- sphinx-build -b html -d docs/_build/doctrees docs docs/_build/html
- sphinx-build -b doctest -d docs/_build/doctrees docs docs/_build/doctest
+ sphinx-build -b html -i -d docs/_build/doctrees docs docs/_build/html
+ sphinx-build -b doctest -i -d docs/_build/doctrees docs docs/_build/doctest
|
Additionally warnings WARNING: autodoc: failed to import class 'mapping.PersistentMapping' from module 'persistent'; the following exception was raised:
No module named 'persistent' [autodoc.import_object]
WARNING: autodoc: failed to import class 'list.PersistentList' from module 'persistent'; the following exception was raised:
No module named 'persistent' [autodoc.import_object]
WARNING: autodoc: failed to import module 'interfaces' from module 'persistent'; the following exception was raised:
No module named 'persistent' [autodoc.import_object]
WARNING: autodoc: failed to import class 'Persistent' from module 'persistent'; the following exception was raised:
No module named 'persistent' [autodoc.import_object] Seems related to issues reported by pytest #172 |
The tox run works and shows no warnings:
|
Please add in tox configuration to run sphinx-build with additional option |
Building the docs with |
Again .. tox docs target is not using --- a/tox.ini
+++ b/tox.ini
@@ -80,5 +80,5 @@
skip_install = false
commands_pre =
commands =
- sphinx-build -b html -d docs/_build/doctrees docs docs/_build/html
- sphinx-build -b doctest -d docs/_build/doctrees docs docs/_build/doctest
+ sphinx-build -b -i html -d docs/_build/doctrees docs docs/_build/html
+ sphinx-build -b -i doctest -d docs/_build/doctrees docs docs/_build/doctest
`` |
There is no point breaking the working tox invocation by adding flags. Please stop posting about it. |
This is not about breaking anything. |
OK, I applied your changes as you proposed them. First try:
So obviously the
Also, running |
P.S.: sphinx-build from Sphinx 8.0.2 does not seem to know the |
Correction: please use [tkloczko@pers-jacek SPECS]$ sphinx-build --help | grep nit
--nitpicky, -n nitpicky mode: warn about all missing references |
OK, now I see warnings. There are no import warnings during the tox run because the module can be imported. The rest, like you said yourself, are not critical. Feel free to propose a PR. |
Good that you just wrote whit I've mentioned on opening ticket ("These are not critical issues"). Just please keep this ticket opened .. maybe someone else will fix that. |
First of all currently it is not possible to use straight
sphinx-build
command to build documentation out of source treeFirst part of warnings can be fixed by patch like below:
This patch fixes what is in the comment and that can of fix is suggested in sphinx example copy.py https://www.sphinx-doc.org/en/master/usage/configuration.html#example-of-configuration-file
Than .. on building my packages I'm using
sphinx-build
command with-n
switch which shows warmings about missing references. These are not critical issues.You can peak on fixes that kind of issues in other projects
latchset/jwcrypto#289
click-contrib/sphinx-click@abc31069
latchset/jwcrypto#289
RDFLib/rdflib-sqlalchemy#95
sissaschool/elementpath@bf869d9e
jaraco/cssutils#21
The text was updated successfully, but these errors were encountered: