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.10.0: sphinx warnings #499

Open
kloczek opened this issue Aug 15, 2021 · 1 comment
Open

0.10.0: sphinx warnings #499

kloczek opened this issue Aug 15, 2021 · 1 comment
Labels
bug docs help wanted Contributions and outside help would be most welcome!

Comments

@kloczek
Copy link

kloczek commented Aug 15, 2021

+ /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] 51 added, 0 changed, 0 removed
reading sources... [100%] usage
/home/tkloczko/rpmbuild/BUILD/nose2-0.10.0/nose2/events.py:docstring of nose2.events.Event.version:1: WARNING: duplicate object description of nose2.events.Event.version, other instance in dev/event_reference, use :noindex: for one of them
/usr/lib64/python3.8/unittest/suite.py:docstring of unittest.suite.TestSuite:1: WARNING: duplicate object description of nose2.loader.PluggableTestLoader.suiteClass, other instance in dev/loader, use :noindex: for one of them
/home/tkloczko/rpmbuild/BUILD/nose2-0.10.0/nose2/loader.py:docstring of nose2.loader.PluggableTestLoader:1: WARNING: duplicate object description of nose2.main.PluggableTestProgram.loaderClass, other instance in dev/main, use :noindex: for one of them
/home/tkloczko/rpmbuild/BUILD/nose2-0.10.0/nose2/runner.py:docstring of nose2.runner.PluggableTestRunner:1: WARNING: duplicate object description of nose2.main.PluggableTestProgram.runnerClass, other instance in dev/main, use :noindex: for one of them
/home/tkloczko/rpmbuild/BUILD/nose2-0.10.0/nose2/session.py:docstring of nose2.session.Session:1: WARNING: duplicate object description of nose2.main.PluggableTestProgram.sessionClass, other instance in dev/main, use :noindex: for one of them
/home/tkloczko/rpmbuild/BUILD/nose2-0.10.0/nose2/events.py:docstring of nose2.events.Hook:1: WARNING: duplicate object description of nose2.events.PluginInterface.hookClass, other instance in dev/plugin_class_reference, use :noindex: for one of them
/home/tkloczko/rpmbuild/BUILD/nose2-0.10.0/nose2/result.py:docstring of nose2.result.PluggableTestResult:1: WARNING: duplicate object description of nose2.runner.PluggableTestRunner.resultClass, other instance in dev/runner, use :noindex: for one of them
<autodoc>:1: WARNING: duplicate configvar description of always-on, other instance in plugins/buffer
<autodoc>:1: WARNING: duplicate configvar description of always-on, other instance in plugins/collect
<autodoc>:1: WARNING: duplicate configvar description of always-on, other instance in plugins/coverage
/home/tkloczko/rpmbuild/BUILD/nose2-0.10.0/nose2/plugins/debugger.py:docstring of nose2.plugins.debugger.Debugger.pdb:1: WARNING: duplicate object description of nose2.plugins.debugger.Debugger.pdb, other instance in plugins/debugger, use :noindex: for one of them
<autodoc>:1: WARNING: duplicate configvar description of always-on, other instance in plugins/debugger
<autodoc>:1: WARNING: duplicate configvar description of always-on, other instance in plugins/discovery
<autodoc>:1: WARNING: duplicate configvar description of always-on, other instance in plugins/doctests
<autodoc>:1: WARNING: duplicate configvar description of always-on, other instance in plugins/eggdiscovery
<autodoc>:1: WARNING: duplicate configvar description of always-on, other instance in plugins/functions
<autodoc>:1: WARNING: duplicate configvar description of always-on, other instance in plugins/generators
<autodoc>:1: WARNING: duplicate configvar description of always-on, other instance in plugins/junitxml
<autodoc>:1: WARNING: duplicate configvar description of always-on, other instance in plugins/layers
<autodoc>:1: WARNING: duplicate configvar description of always-on, other instance in plugins/loadtests
<autodoc>:1: WARNING: duplicate configvar description of always-on, other instance in plugins/logcapture
<autodoc>:1: WARNING: duplicate configvar description of always-on, other instance in plugins/mp
<autodoc>:1: WARNING: duplicate configvar description of always-on, other instance in plugins/outcomes
<autodoc>:1: WARNING: duplicate configvar description of always-on, other instance in plugins/parameters
<autodoc>:1: WARNING: duplicate configvar description of always-on, other instance in plugins/prettyassert
<autodoc>:1: WARNING: duplicate configvar description of always-on, other instance in plugins/printhooks
<autodoc>:1: WARNING: duplicate configvar description of always-on, other instance in plugins/prof
<autodoc>:1: WARNING: duplicate configvar description of always-on, other instance in plugins/result
<autodoc>:1: WARNING: duplicate configvar description of always-on, other instance in plugins/testcases
<autodoc>:1: WARNING: duplicate configvar description of always-on, other instance in plugins/testclasses
looking for now-outdated files... none found
pickling environment... done
checking consistency... done
writing... python-nose2.3 { getting_started usage configuration differences plugins plugins/discovery plugins/functions plugins/generators plugins/parameters plugins/testcases plugins/testclasses plugins/loadtests plugins/dundertests plugins/result plugins/buffer plugins/debugger plugins/failfast plugins/logcapture plugins/coverage plugins/prettyassert plugins/junitxml plugins/attrib plugins/mp plugins/layers plugins/doctests plugins/outcomes plugins/collect plugins/testid plugins/prof plugins/printhooks plugins/eggdiscovery tools decorators params such_dsl changelog dev/writing_plugins dev/documenting_plugins dev/event_reference dev/hook_reference dev/session_reference dev/plugin_class_reference dev/contributing dev/internals dev/main dev/exceptions dev/loader dev/result dev/runner dev/utils } /home/tkloczko/rpmbuild/BUILD/nose2-0.10.0/nose2/plugins/result.py:docstring of nose2.plugins.result:7: WARNING: unknown option: verbose
/home/tkloczko/rpmbuild/BUILD/nose2-0.10.0/docs/plugins/mp.rst:24: WARNING: unknown option: --plugin
/home/tkloczko/rpmbuild/BUILD/nose2-0.10.0/docs/plugins/eggdiscovery.rst:27: WARNING: unknown option: --plugin
done
build succeeded, 33 warnings.
@sirosen
Copy link
Collaborator

sirosen commented Aug 17, 2021

I think these warnings are mostly a new sphinx behavior (sphinx v4). We can declare nose2's doc build as using sphinx>=3,<4 if any serious issues crop up, but I think the docs still build correctly under v4.

Fixing these warnings might require tinkering with the sphinx extension.

I think we somehow want to instruct Sphinx that this warning is a false positive -- the content is indeed duplicated, but this is intentional. If anyone knows how to do this, I'd greatly appreciate the help. I can apply a working fix to the extension if that's a bit too involved.

@sirosen sirosen added bug docs help wanted Contributions and outside help would be most welcome! labels Aug 17, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug docs help wanted Contributions and outside help would be most welcome!
Projects
None yet
Development

No branches or pull requests

2 participants