zopefoundation / zope.exceptions

exceptions and implementations which are general purpose
https://zopeexceptions.readthedocs.io/
Other
0 stars 6 forks source link

4.4: sphinx warnings #22

Open kloczek opened 2 years ago

kloczek commented 2 years ago

Looks like sphinsx shows some warnings

+ /usr/bin/python3 setup.py build_sphinx -b man --build-dir build/sphinx
running build_sphinx
Running Sphinx v4.1.2
making output directory... done
loading intersphinx inventory from http://docs.python.org/objects.inv...
intersphinx inventory has moved: http://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] 4 added, 0 changed, 0 removed
reading sources... [100%] narr
WARNING: autodoc: failed to import module 'exceptions.interfaces' from module 'zope'; the following exception was raised:
No module named 'zope.exceptions'
/home/tkloczko/rpmbuild/BUILD/zope.exceptions-4.4/docs/api.rst:13: WARNING: An option to autointerface is either unknown or has an invalid value: (option: "member-order"; value: 'source')
invalid value for member-order option: source
WARNING: autodoc: failed to import module 'exceptions.exceptionformatter' from module 'zope'; the following exception was raised:
No module named 'zope.exceptions'
WARNING: autodoc: failed to import function 'exceptions.exceptionformatter.format_exception' from module 'zope'; the following exception was raised:
No module named 'zope.exceptions'
WARNING: autodoc: failed to import function 'exceptions.exceptionformatter.print_exception' from module 'zope'; the following exception was raised:
No module named 'zope.exceptions'
WARNING: autodoc: failed to import function 'exceptions.exceptionformatter.extract_stack' from module 'zope'; the following exception was raised:
No module named 'zope.exceptions'
looking for now-outdated files... none found
pickling environment... done
checking consistency... done
writing... python-zope-exceptions.3 { narr api hacking } done
build succeeded, 6 warnings.
icemac commented 2 years ago

You are not using Sphinx in a way where it is correctly configured for this project. See tox.ini how to run it in the way the project expects it. Docs for this project are built using tox -edocs

https://github.com/zopefoundation/zope.exceptions/runs/3213696824?check_suite_focus=true shows the actual warnings:

/home/runner/work/zope.exceptions/zope.exceptions/docs/api.rst:13: WARNING: An option to autointerface is either unknown or has an invalid value: (option: "member-order"; value: 'source')
invalid value for member-order option: source
looking for now-outdated files... none found
pickling environment... done
checking consistency... done
preparing documents... done
writing output... [ 25%] api
writing output... [ 50%] hacking
writing output... [ 75%] index
writing output... [100%] narr

/home/runner/work/zope.exceptions/zope.exceptions/docs/narr.rst:130: WARNING: Could not lex literal_block as "pycon3". Highlighting skipped.
generating indices... genindex py-modindex done
highlighting module code... [100%] zope.exceptions.exceptionformatter

writing additional pages... search done
copying static files... done
copying extra files... done
dumping search index in English (code: en)... done
dumping object inventory... done
build succeeded, 2 warnings.
kloczek commented 2 years ago

You are not using Sphinx in a way where it is correctly configured for this project. See tox.ini how to run it in the way the project expects it. Docs for this project are built using tox -edocs

Sorry but you are wromng. If you will look closer on tox.ini you will be able to sing that you are forcing use sphinx < 4. Sesond line from the output which I've copied

Running Sphinx v4.1.2

If you will remove that foring even usin g tox you will be able to see exacrly what I've copied.