Open kloczek opened 3 years ago
Thanks for the report. I don't have yet sphinx 4.x, I'll have to check out what's happening.
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.
OK will check that patch shortly. Thank you :)
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.
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.
Hmm, these are all man build warnings. I’ll first add CI for normal (html) builds, and see about this.
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 😋
Updated list of warnings against 0.8.1 + master (after switching to myst-parser)
+ /usr/bin/sphinx-build -n -T -b man doc build/sphinx/man
Running Sphinx v7.1.2
making output directory... done
myst v2.0.0: MdParserConfig(commonmark_only=False, gfm_only=False, enable_extensions=set(), disable_syntax=[], all_links_external=False, url_schemes=('http', 'https', 'mailto', 'ftp'), ref_domains=None, fence_as_directive=set(), number_code_blocks=[], title_to_header=False, heading_anchors=0, heading_slug_func=None, html_meta={}, footnote_transition=True, words_per_minute=200, substitutions={}, linkify_fuzzy_links=True, dmath_allow_labels=True, dmath_allow_space=True, dmath_allow_digits=True, dmath_double_inline=False, update_mathjax=True, mathjax_classes='tex2jax_process|mathjax_process|math|output_area', enable_checkboxes=False, suppress_warnings=[], highlight_code_blocks=True)
building [mo]: targets for 0 po files that are out of date
writing output...
building [man]: all manpages
updating environment: [new config] 6 added, 0 changed, 0 removed
reading sources... [100%] security
looking for now-outdated files... none found
pickling environment... done
checking consistency... done
writing... python-pyxattr.3 { readme contributing security module news } /home/tkloczko/rpmbuild/BUILD/pyxattr-0.8.1/docstring of xattr.list:1: WARNING: py:class reference target not found: boolean
/home/tkloczko/rpmbuild/BUILD/pyxattr-0.8.1/docstring of xattr.list:1: WARNING: py:class reference target not found: optional
/home/tkloczko/rpmbuild/BUILD/pyxattr-0.8.1/docstring of xattr.get:1: WARNING: py:class reference target not found: string
/home/tkloczko/rpmbuild/BUILD/pyxattr-0.8.1/docstring of xattr.get:1: WARNING: py:class reference target not found: boolean
/home/tkloczko/rpmbuild/BUILD/pyxattr-0.8.1/docstring of xattr.get:1: WARNING: py:class reference target not found: optional
/home/tkloczko/rpmbuild/BUILD/pyxattr-0.8.1/docstring of xattr.get:1: WARNING: py:class reference target not found: string
/home/tkloczko/rpmbuild/BUILD/pyxattr-0.8.1/docstring of xattr.get_all:1: WARNING: py:class reference target not found: string
/home/tkloczko/rpmbuild/BUILD/pyxattr-0.8.1/docstring of xattr.get_all:1: WARNING: py:class reference target not found: boolean
/home/tkloczko/rpmbuild/BUILD/pyxattr-0.8.1/docstring of xattr.get_all:1: WARNING: py:class reference target not found: optional
/home/tkloczko/rpmbuild/BUILD/pyxattr-0.8.1/docstring of xattr.set:1: WARNING: py:class reference target not found: string
/home/tkloczko/rpmbuild/BUILD/pyxattr-0.8.1/docstring of xattr.set:1: WARNING: py:class reference target not found: string
/home/tkloczko/rpmbuild/BUILD/pyxattr-0.8.1/docstring of xattr.set:1: WARNING: py:class reference target not found: integer
/home/tkloczko/rpmbuild/BUILD/pyxattr-0.8.1/docstring of xattr.set:1: WARNING: py:class reference target not found: boolean
/home/tkloczko/rpmbuild/BUILD/pyxattr-0.8.1/docstring of xattr.set:1: WARNING: py:class reference target not found: optional
/home/tkloczko/rpmbuild/BUILD/pyxattr-0.8.1/docstring of xattr.remove:1: WARNING: py:class reference target not found: string
/home/tkloczko/rpmbuild/BUILD/pyxattr-0.8.1/docstring of xattr.remove:1: WARNING: py:class reference target not found: boolean
/home/tkloczko/rpmbuild/BUILD/pyxattr-0.8.1/docstring of xattr.remove:1: WARNING: py:class reference target not found: optional
/home/tkloczko/rpmbuild/BUILD/pyxattr-0.8.1/docstring of xattr.getxattr:1: WARNING: py:class reference target not found: string
/home/tkloczko/rpmbuild/BUILD/pyxattr-0.8.1/docstring of xattr.getxattr:1: WARNING: py:class reference target not found: boolean
/home/tkloczko/rpmbuild/BUILD/pyxattr-0.8.1/docstring of xattr.getxattr:1: WARNING: py:class reference target not found: optional
/home/tkloczko/rpmbuild/BUILD/pyxattr-0.8.1/docstring of xattr.setxattr:1: WARNING: py:class reference target not found: string
/home/tkloczko/rpmbuild/BUILD/pyxattr-0.8.1/docstring of xattr.setxattr:1: WARNING: py:class reference target not found: string
/home/tkloczko/rpmbuild/BUILD/pyxattr-0.8.1/docstring of xattr.setxattr:1: WARNING: py:class reference target not found: integer
/home/tkloczko/rpmbuild/BUILD/pyxattr-0.8.1/docstring of xattr.setxattr:1: WARNING: py:class reference target not found: boolean
/home/tkloczko/rpmbuild/BUILD/pyxattr-0.8.1/docstring of xattr.setxattr:1: WARNING: py:class reference target not found: optional
/home/tkloczko/rpmbuild/BUILD/pyxattr-0.8.1/docstring of xattr.listxattr:1: WARNING: py:class reference target not found: boolean
/home/tkloczko/rpmbuild/BUILD/pyxattr-0.8.1/docstring of xattr.listxattr:1: WARNING: py:class reference target not found: optional
/home/tkloczko/rpmbuild/BUILD/pyxattr-0.8.1/docstring of xattr.removexattr:1: WARNING: py:class reference target not found: string
/home/tkloczko/rpmbuild/BUILD/pyxattr-0.8.1/docstring of xattr.removexattr:1: WARNING: py:class reference target not found: boolean
/home/tkloczko/rpmbuild/BUILD/pyxattr-0.8.1/docstring of xattr.removexattr:1: WARNING: py:class reference target not found: optional
done
build succeeded, 30 warnings.
You can peak on fixes that kind of issues in other projects https://github.com/RDFLib/rdflib-sqlalchemy/issues/95 https://github.com/RDFLib/rdflib/pull/2036 https://github.com/click-contrib/sphinx-click/commit/abc31069 https://github.com/frostming/unearth/issues/14 https://github.com/jaraco/cssutils/issues/21 https://github.com/latchset/jwcrypto/pull/289 https://github.com/latchset/jwcrypto/pull/289 https://github.com/pypa/distlib/commit/98b9b89f https://github.com/pywbem/pywbem/pull/2895 https://github.com/sissaschool/elementpath/commit/bf869d9e https://github.com/sissaschool/xmlschema/commit/42ea98f2 https://github.com/sqlalchemy/sqlalchemy/commit/5e88e6e8