René's URL Explorer Experiment

{"@context":"https://schema.org","@type":"DiscussionForumPosting","headline":"1.0.4: sphinx warnings `reference target not found`","articleBody":"First of all currently it is not possible to use straight `sphinx-build` command to build documentation out of source tree\r\n\u003cdetails\u003e\r\n\r\n```console\r\n+ /usr/bin/sphinx-build -n -T -b man docs build/sphinx/man\r\nRunning Sphinx v5.0.1\r\nmaking output directory... done\r\nWARNING: html_static_path entry '_static' does not exist\r\nbuilding [mo]: targets for 0 po files that are out of date\r\nbuilding [man]: all manpages\r\nupdating environment: [new config] 3 added, 0 changed, 0 removed\r\nreading sources... [100%] index\r\nWARNING: autodoc: failed to import function 'pack' from module 'msgpack'; the following exception was raised:\r\nNo module named 'msgpack'\r\nWARNING: autodoc: failed to import function 'packb' from module 'msgpack'; the following exception was raised:\r\nNo module named 'msgpack'\r\nWARNING: autodoc: failed to import function 'unpack' from module 'msgpack'; the following exception was raised:\r\nNo module named 'msgpack'\r\nWARNING: autodoc: failed to import function 'unpackb' from module 'msgpack'; the following exception was raised:\r\nNo module named 'msgpack'\r\nWARNING: autodoc: failed to import class 'Packer' from module 'msgpack'; the following exception was raised:\r\nNo module named 'msgpack'\r\nWARNING: autodoc: failed to import class 'Unpacker' from module 'msgpack'; the following exception was raised:\r\nNo module named 'msgpack'\r\nWARNING: autodoc: failed to import class 'ExtType' from module 'msgpack'; the following exception was raised:\r\nNo module named 'msgpack'\r\nWARNING: autodoc: failed to import class 'Timestamp' from module 'msgpack'; the following exception was raised:\r\nNo module named 'msgpack'\r\nWARNING: autodoc: failed to import module 'exceptions' from module 'msgpack'; the following exception was raised:\r\nNo module named 'msgpack'\r\nlooking for now-outdated files... none found\r\npickling environment... done\r\nchecking consistency... done\r\nwriting... python-msgpack.3 { api advanced } /home/tkloczko/rpmbuild/BUILD/msgpack-python-1.0.4/docs/api.rst:8: WARNING: py:func reference target not found: dump\r\n/home/tkloczko/rpmbuild/BUILD/msgpack-python-1.0.4/docs/api.rst:8: WARNING: py:func reference target not found: pack\r\n/home/tkloczko/rpmbuild/BUILD/msgpack-python-1.0.4/docs/api.rst:12: WARNING: py:func reference target not found: dumps\r\n/home/tkloczko/rpmbuild/BUILD/msgpack-python-1.0.4/docs/api.rst:12: WARNING: py:func reference target not found: packb\r\n/home/tkloczko/rpmbuild/BUILD/msgpack-python-1.0.4/docs/api.rst:16: WARNING: py:func reference target not found: load\r\n/home/tkloczko/rpmbuild/BUILD/msgpack-python-1.0.4/docs/api.rst:16: WARNING: py:func reference target not found: unpack\r\n/home/tkloczko/rpmbuild/BUILD/msgpack-python-1.0.4/docs/api.rst:20: WARNING: py:func reference target not found: loads\r\n/home/tkloczko/rpmbuild/BUILD/msgpack-python-1.0.4/docs/api.rst:20: WARNING: py:func reference target not found: unpackb\r\n/home/tkloczko/rpmbuild/BUILD/msgpack-python-1.0.4/docs/advanced.rst:10: WARNING: py:class reference target not found: msgpack.Packer\r\n/home/tkloczko/rpmbuild/BUILD/msgpack-python-1.0.4/docs/advanced.rst:13: WARNING: py:meth reference target not found: msgpack.Packer.bytes\r\n/home/tkloczko/rpmbuild/BUILD/msgpack-python-1.0.4/docs/advanced.rst:13: WARNING: py:meth reference target not found: msgpack.Packer.getbuffer\r\ndone\r\nbuild succeeded, 21 warnings.\r\n```\r\n\u003c/details\u003e\r\n\r\nFirst part of warnings can be fixed by patch like below:\r\n```patch\r\n--- a/docs/conf.py~     2022-06-05 08:01:50.000000000 +0000\r\n+++ b/docs/conf.py      2022-06-05 08:02:43.878255796 +0000\r\n@@ -16,7 +16,7 @@\r\n # If extensions (or modules to document with autodoc) are in another directory,\r\n # add these directories to sys.path here. If the directory is relative to the\r\n # documentation root, use os.path.abspath to make it absolute, like shown here.\r\n-# sys.path.insert(0, os.path.abspath('.'))\r\n+sys.path.insert(0, os.path.abspath(\"..\"))\r\n\r\n # -- General configuration -----------------------------------------------------\r\n author = \"Inada Naoki\"\r\n\r\n```\r\nThis 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\r\n\r\nThan .. on building my packages I'm using `sphinx-build` command with `-n` switch which shows warmings about missing references. These are not critical issues.\r\n\r\n\u003cdetails\u003e\r\n\r\n```console\r\n+ /usr/bin/sphinx-build -n -T -b man docs build/sphinx/man\r\nRunning Sphinx v5.0.1\r\nmaking output directory... done\r\nWARNING: html_static_path entry '_static' does not exist\r\nbuilding [mo]: targets for 0 po files that are out of date\r\nbuilding [man]: all manpages\r\nupdating environment: [new config] 3 added, 0 changed, 0 removed\r\nreading sources... [100%] index\r\nlooking for now-outdated files... none found\r\npickling environment... done\r\nchecking consistency... done\r\nwriting... python-msgpack.3 { api advanced } /home/tkloczko/rpmbuild/BUILD/msgpack-python-1.0.4/docs/api.rst:8: WARNING: py:func reference target not found: dump\r\n/home/tkloczko/rpmbuild/BUILD/msgpack-python-1.0.4/docs/api.rst:12: WARNING: py:func reference target not found: dumps\r\n/home/tkloczko/rpmbuild/BUILD/msgpack-python-1.0.4/docs/api.rst:16: WARNING: py:func reference target not found: load\r\n/home/tkloczko/rpmbuild/BUILD/msgpack-python-1.0.4/docs/api.rst:20: WARNING: py:func reference target not found: loads\r\n/home/tkloczko/rpmbuild/BUILD/msgpack-python-1.0.4/msgpack/fallback.py:docstring of msgpack.fallback.Packer:: WARNING: py:class reference target not found: callable\r\n/home/tkloczko/rpmbuild/BUILD/msgpack-python-1.0.4/msgpack/fallback.py:docstring of msgpack.fallback.Unpacker:6: WARNING: py:meth reference target not found: feed\r\n/home/tkloczko/rpmbuild/BUILD/msgpack-python-1.0.4/msgpack/fallback.py:docstring of msgpack.fallback.Unpacker:: WARNING: py:class reference target not found: callable\r\n/home/tkloczko/rpmbuild/BUILD/msgpack-python-1.0.4/msgpack/fallback.py:docstring of msgpack.fallback.Unpacker:: WARNING: py:class reference target not found: callable\r\n/home/tkloczko/rpmbuild/BUILD/msgpack-python-1.0.4/msgpack/ext.py:docstring of msgpack.ext.Timestamp.from_unix:: WARNING: py:class reference target not found: float.\r\n/home/tkloczko/rpmbuild/BUILD/msgpack-python-1.0.4/msgpack/ext.py:docstring of msgpack.ext.Timestamp.to_datetime:: WARNING: py:class reference target not found: datetime.\r\ndone\r\nbuild succeeded, 11 warnings.\r\n```\r\n\u003c/details\u003e\r\n\r\nYou can peak on fixes that kind of issues in other projects\r\nhttps://github.com/latchset/jwcrypto/pull/289\r\nhttps://github.com/click-contrib/sphinx-click/commit/abc31069\r\nhttps://github.com/latchset/jwcrypto/pull/289\r\nhttps://github.com/RDFLib/rdflib-sqlalchemy/issues/95\r\nhttps://github.com/sissaschool/elementpath/commit/bf869d9e\r\n","author":{"url":"https://github.com/kloczek","@type":"Person","name":"kloczek"},"datePublished":"2022-06-05T08:08:46.000Z","interactionStatistic":{"@type":"InteractionCounter","interactionType":"https://schema.org/CommentAction","userInteractionCount":5},"url":"https://github.com/510/msgpack-python/issues/510"}