0.7.2: sphinx warnings

[kloczek]

trafficstars

+ /usr/bin/python3 setup.py build_sphinx -b man
running build_sphinx
Running Sphinx v4.0.2
making output directory... done
building [mo]: targets for 0 po files that are out of date
building [man]: all manpages
updating environment: [new config] 2 added, 0 changed, 0 removed
reading sources... [100%] module
/home/tkloczko/rpmbuild/BUILD/pyxattr-0.7.2/doc/index.rst:11: WARNING: toctree contains reference to nonexisting document 'readme'
/home/tkloczko/rpmbuild/BUILD/pyxattr-0.7.2/doc/index.rst:11: WARNING: toctree contains reference to nonexisting document 'news'
looking for now-outdated files... none found
pickling environment... done
checking consistency... done
writing... pyxattr.1 { module } /home/tkloczko/rpmbuild/BUILD/pyxattr-0.7.2/doc/index.rst:5: WARNING: unknown document: readme
done
build succeeded, 3 warnings.

[iustin]

Thanks for the report. I don't have yet sphinx 4.x, I'll have to check out what's happening.

[iustin]

Ah, ignore that. This is a problem with all sphinx version, and has been fixed in c9283c897783cca04479. I'll need to make a new minor release.

[kloczek]

OK will check that patch shortly. Thank you :)

[kloczek]

Tested that commit and it fixes reported warnings (thank you) however with latest sphinx looks like new warnings started popping up :)

+ /usr/bin/python3 setup.py build_sphinx -b man --build-dir build/sphinx
running build_sphinx
Running Sphinx v4.3.2
making output directory... done
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
/usr/lib/python3.8/site-packages/recommonmark/parser.py:75: UserWarning: Container node skipped: type=document
  warn("Container node skipped: type={0}".format(mdnode.t))

WARNING: autodoc: failed to import module 'xattr'; the following exception was raised:
No module named 'xattr'
WARNING: don't know which module to import for autodocumenting 'list' (try placing a "module" or "currentmodule" directive in the document, or giving an explicit module name)
WARNING: don't know which module to import for autodocumenting 'get' (try placing a "module" or "currentmodule" directive in the document, or giving an explicit module name)
WARNING: don't know which module to import for autodocumenting 'get_all' (try placing a "module" or "currentmodule" directive in the document, or giving an explicit module name)
WARNING: don't know which module to import for autodocumenting 'set' (try placing a "module" or "currentmodule" directive in the document, or giving an explicit module name)
WARNING: don't know which module to import for autodocumenting 'remove' (try placing a "module" or "currentmodule" directive in the document, or giving an explicit module name)
WARNING: don't know which module to import for autodocumenting 'getxattr' (try placing a "module" or "currentmodule" directive in the document, or giving an explicit module name)
WARNING: don't know which module to import for autodocumenting 'setxattr' (try placing a "module" or "currentmodule" directive in the document, or giving an explicit module name)
WARNING: don't know which module to import for autodocumenting 'listxattr' (try placing a "module" or "currentmodule" directive in the document, or giving an explicit module name)
WARNING: don't know which module to import for autodocumenting 'removexattr' (try placing a "module" or "currentmodule" directive in the document, or giving an explicit module name)
looking for now-outdated files... none found
pickling environment... done
checking consistency... done
writing... python-pyxattr.3 { readme module news } done
build succeeded, 10 warnings.

[kloczek]

Here is another batch of warnings

[tkloczko@devel-g2v pyxattr-0.7.2]$ PYTHONPATH=$PWD/build/$(cd build; ls -d1 lib*) /usr/bin/sphinx-build -n -T -b man doc build/sphinx/man
Running Sphinx v4.5.0
loading pickled environment... done
building [mo]: targets for 0 po files that are out of date
building [man]: all manpages
updating environment: 0 added, 0 changed, 0 removed
looking for now-outdated files... none found
writing... python-pyxattr.3 { readme module news } docstring of xattr.list:: WARNING: py:class reference target not found: boolean
docstring of xattr.list:: WARNING: py:class reference target not found: optional
docstring of xattr.get:: WARNING: py:class reference target not found: string
docstring of xattr.get:: WARNING: py:class reference target not found: boolean
docstring of xattr.get:: WARNING: py:class reference target not found: optional
docstring of xattr.get:: WARNING: py:class reference target not found: string
docstring of xattr.get_all:: WARNING: py:class reference target not found: string
docstring of xattr.get_all:: WARNING: py:class reference target not found: boolean
docstring of xattr.get_all:: WARNING: py:class reference target not found: optional
docstring of xattr.set:: WARNING: py:class reference target not found: string
docstring of xattr.set:: WARNING: py:class reference target not found: string
docstring of xattr.set:: WARNING: py:class reference target not found: integer
docstring of xattr.set:: WARNING: py:class reference target not found: boolean
docstring of xattr.set:: WARNING: py:class reference target not found: optional
docstring of xattr.remove:: WARNING: py:class reference target not found: string
docstring of xattr.remove:: WARNING: py:class reference target not found: boolean
docstring of xattr.remove:: WARNING: py:class reference target not found: optional
docstring of xattr.getxattr:: WARNING: py:class reference target not found: string
docstring of xattr.getxattr:: WARNING: py:class reference target not found: boolean
docstring of xattr.getxattr:: WARNING: py:class reference target not found: optional
docstring of xattr.setxattr:: WARNING: py:class reference target not found: string
docstring of xattr.setxattr:: WARNING: py:class reference target not found: string
docstring of xattr.setxattr:: WARNING: py:class reference target not found: integer
docstring of xattr.setxattr:: WARNING: py:class reference target not found: boolean
docstring of xattr.setxattr:: WARNING: py:class reference target not found: optional
docstring of xattr.listxattr:: WARNING: py:class reference target not found: boolean
docstring of xattr.listxattr:: WARNING: py:class reference target not found: optional
docstring of xattr.removexattr:: WARNING: py:class reference target not found: string
docstring of xattr.removexattr:: WARNING: py:class reference target not found: boolean
docstring of xattr.removexattr:: WARNING: py:class reference target not found: optional
done
build succeeded, 30 warnings.

The manual pages are in build/sphinx/man.

[iustin]

Hmm, these are all man build warnings. I’ll first add CI for normal (html) builds, and see about this.

[kloczek]

Those warnings mainly affects html in which exact keywords are only highlited (and are without links). I'm interested only roff output (man page) so I;m not affected by those warnings. Nevertheless I've repoted that as part of the review of my build process 😋