You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
First of all currently it is not possible to use straight sphinx-build command to build documentation out of source tree
+ /usr/bin/sphinx-build -n -T -b man docs build/sphinx/manRunning Sphinx v7.0.1Traceback (most recent call last): File "/usr/lib/python3.8/site-packages/sphinx/config.py", line 354, in eval_config_file exec(code, namespace) # NoQA: S102 File "/home/tkloczko/rpmbuild/BUILD/plumbum-1.8.2/docs/conf.py", line 53, in <module> from plumbum.version import version as releaseModuleNotFoundError: No module named 'plumbum'The above exception was the direct cause of the following exception:Traceback (most recent call last): File "/usr/lib/python3.8/site-packages/sphinx/cmd/build.py", line 280, in build_main app = Sphinx(args.sourcedir, args.confdir, args.outputdir, File "/usr/lib/python3.8/site-packages/sphinx/application.py", line 207, in __init__ self.config = Config.read(self.confdir, confoverrides or {}, self.tags) File "/usr/lib/python3.8/site-packages/sphinx/config.py", line 177, in read namespace = eval_config_file(filename, tags) File "/usr/lib/python3.8/site-packages/sphinx/config.py", line 367, in eval_config_file raise ConfigError(msg % traceback.format_exc()) from excsphinx.errors.ConfigError: There is a programmable error in your configuration file:Traceback (most recent call last): File "/usr/lib/python3.8/site-packages/sphinx/config.py", line 354, in eval_config_file exec(code, namespace) # NoQA: S102 File "/home/tkloczko/rpmbuild/BUILD/plumbum-1.8.2/docs/conf.py", line 53, in <module> from plumbum.version import version as releaseModuleNotFoundError: No module named 'plumbum'Configuration error:There is a programmable error in your configuration file:Traceback (most recent call last): File "/usr/lib/python3.8/site-packages/sphinx/config.py", line 354, in eval_config_file exec(code, namespace) # NoQA: S102 File "/home/tkloczko/rpmbuild/BUILD/plumbum-1.8.2/docs/conf.py", line 53, in <module> from plumbum.version import version as releaseModuleNotFoundError: No module named 'plumbum'
This can be fixed by patch like below:
--- a/docs/conf.py+++ b/docs/conf.py@@ -17,7 +17,7 @@
# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
-# sys.path.insert(0, os.path.abspath('.'))+sys.path.insert(0, os.path.abspath('..'))
# -- General configuration -----------------------------------------------------
Than .. on building my packages I'm using sphinx-build command with -n switch which shows warmings about missing references. These are not critical issues.
Here is sphinx output with warnings:
+ /usr/bin/sphinx-build -n -T -b man docs build/sphinx/manRunning Sphinx v7.0.1making output directory... donebuilding [mo]: targets for 0 po files that are out of datewriting output...building [man]: all manpagesupdating environment: [new config] 18 added, 0 changed, 0 removedreading sources... [100%] utils/home/tkloczko/rpmbuild/BUILD/plumbum-1.8.2/plumbum/colorlib/styles.py:docstring of plumbum.colorlib.styles.Color.number:1: WARNING: duplicate object description of plumbum.colorlib.styles.Color.number, other instance in api/colors, use :noindex: for one of them/home/tkloczko/rpmbuild/BUILD/plumbum-1.8.2/docs/quickref.rst:75: ERROR: Malformed table.Text in column margin in table line 12.====================== =====================================Utility Usage====================== =====================================``PROGNAME=`` Custom program name and/or color``VERSION=`` Custom version``DESCRIPTION=`` Custom description (or use docstring)``DESCRIPTION_MORE=`` Custom description with whitespace``ALLOW_ABREV=True`` Allow argparse style abbreviations``COLOR_USAGE=`` Custom color for usage statement``COLOR_USAGE_TITLE=`` Custom color for usage statement's title``COLOR_GROUPS=`` Colors of groups (dictionary)``COLOR_GROUP_TITLES=`` Colors of group titles (dictionary)====================== =====================================looking for now-outdated files... none foundpickling environment... donechecking consistency... donewriting... python-plumbum.3 { local_commands paths local_machine remote utils cli typed_env colors changelog quickref api/cli api/commands api/machines api/path api/fs api/colors colorlib } /home/tkloczko/rpmbuild/BUILD/plumbum-1.8.2/docs/paths.rst:7: WARNING: py:func reference target not found: platform.local_machine.LocalMachine.path/home/tkloczko/rpmbuild/BUILD/plumbum-1.8.2/docs/remote.rst:36: WARNING: py:class reference target not found: plumbum.remote_machine.SshMachine/home/tkloczko/rpmbuild/BUILD/plumbum-1.8.2/docs/remote.rst:43: WARNING: py:class reference target not found: plumbum.remote_machine.PuttyMachine/home/tkloczko/rpmbuild/BUILD/plumbum-1.8.2/docs/remote.rst:190: WARNING: py:class reference target not found: plumbum.paramiko_machine.ParamikoMachine/home/tkloczko/rpmbuild/BUILD/plumbum-1.8.2/docs/utils.rst:34: WARNING: py:func reference target not found: plumbum.path.utils.xdg_open/home/tkloczko/rpmbuild/BUILD/plumbum-1.8.2/docs/cli.rst:14: WARNING: py:class reference target not found: plumbum.cli.Application/home/tkloczko/rpmbuild/BUILD/plumbum-1.8.2/docs/cli.rst:14: WARNING: py:func reference target not found: plumbum.cli.switch/home/tkloczko/rpmbuild/BUILD/plumbum-1.8.2/docs/cli.rst:57: WARNING: py:class reference target not found: plumbum.cli.Application/home/tkloczko/rpmbuild/BUILD/plumbum-1.8.2/docs/cli.rst:125: WARNING: py:func reference target not found: plumbum.cli.switch/home/tkloczko/rpmbuild/BUILD/plumbum-1.8.2/docs/cli.rst:154: WARNING: py:func reference target not found: plumbum.cli.autoswitch/home/tkloczko/rpmbuild/BUILD/plumbum-1.8.2/docs/cli.rst:322: WARNING: py:class reference target not found: plumbum.cli.SwitchAttr/home/tkloczko/rpmbuild/BUILD/plumbum-1.8.2/docs/typed_env.rst:5: WARNING: py:class reference target not found: plumbum.cli.Application/home/tkloczko/rpmbuild/BUILD/plumbum-1.8.2/docs/typed_env.rst:5: WARNING: py:class reference target not found: plumbum.typed_env.TypedEnv/home/tkloczko/rpmbuild/BUILD/plumbum-1.8.2/plumbum/cli/switches.py:docstring of plumbum.cli.switches.switch:25: WARNING: py:func reference target not found: plumbum.cli.WrongArgumentType/home/tkloczko/rpmbuild/BUILD/plumbum-1.8.2/plumbum/cli/switches.py:docstring of plumbum.cli.switches.switch:42: WARNING: py:class reference target not found: plumbum.cli.MissingMandatorySwitch/home/tkloczko/rpmbuild/BUILD/plumbum-1.8.2/plumbum/cli/switches.py:docstring of plumbum.cli.switches.switch:46: WARNING: py:class reference target not found: plumbum.cli.SwitchCombinationError/home/tkloczko/rpmbuild/BUILD/plumbum-1.8.2/plumbum/cli/switches.py:docstring of plumbum.cli.switches.switch:62: WARNING: py:class reference target not found: plumbum.cli.SwitchCombinationError/home/tkloczko/rpmbuild/BUILD/plumbum-1.8.2/plumbum/cli/switches.py:docstring of plumbum.cli.switches.autoswitch:1: WARNING: py:func reference target not found: plumbum.cli.switch/home/tkloczko/rpmbuild/BUILD/plumbum-1.8.2/plumbum/cli/switches.py:docstring of plumbum.cli.switches.SwitchAttr:14: WARNING: py:func reference target not found: plumbum.cli.switch/home/tkloczko/rpmbuild/BUILD/plumbum-1.8.2/plumbum/cli/switches.py:docstring of plumbum.cli.switches.Flag:1: WARNING: py:class reference target not found: plumbum.cli.SwitchAttr/home/tkloczko/rpmbuild/BUILD/plumbum-1.8.2/plumbum/cli/switches.py:docstring of plumbum.cli.switches.Flag:10: WARNING: py:func reference target not found: plumbum.cli.switch/home/tkloczko/rpmbuild/BUILD/plumbum-1.8.2/plumbum/cli/switches.py:docstring of plumbum.cli.switches.CountOf:1: WARNING: py:class reference target not found: plumbum.cli.SwitchAttr/home/tkloczko/rpmbuild/BUILD/plumbum-1.8.2/plumbum/cli/switches.py:docstring of plumbum.cli.switches.CountOf:11: WARNING: py:func reference target not found: plumbum.cli.switch/home/tkloczko/rpmbuild/BUILD/plumbum-1.8.2/plumbum/cli/switches.py:docstring of plumbum.cli.switches.Set:1: WARNING: py:class reference target not found: collections.abc.Set/home/tkloczko/rpmbuild/BUILD/plumbum-1.8.2/plumbum/commands/base.py:docstring of plumbum.commands.processes.iter_lines:1: WARNING: py:class reference target not found: plumbum.commands.ProcessExecutionError/home/tkloczko/rpmbuild/BUILD/plumbum-1.8.2/plumbum/commands/base.py:docstring of plumbum.commands.processes.iter_lines:17: WARNING: py:class reference target not found: plumbum.commands.ProcessLineTimedOut/home/tkloczko/rpmbuild/BUILD/plumbum-1.8.2/plumbum/commands/base.py:docstring of plumbum.commands.processes.run_proc:10: WARNING: py:class reference target not found: plumbum.cli.ProcessTimedOut/home/tkloczko/rpmbuild/BUILD/plumbum-1.8.2/plumbum/commands/base.py:docstring of plumbum.commands.base.BaseCommand.popen:5: WARNING: py:class reference target not found: plumbum.commands.BG/home/tkloczko/rpmbuild/BUILD/plumbum-1.8.2/plumbum/commands/base.py:docstring of plumbum.commands.base.BaseCommand.bgrun:18: WARNING: py:class reference target not found: plumbum.commands.BG/home/tkloczko/rpmbuild/BUILD/plumbum-1.8.2/plumbum/commands/base.py:docstring of plumbum.commands.base.BaseCommand.run:1: WARNING: py:func reference target not found: plumbum.commands.run_proc/home/tkloczko/rpmbuild/BUILD/plumbum-1.8.2/plumbum/commands/base.py:docstring of plumbum.commands.base.BaseCommand.run:1: WARNING: py:class reference target not found: plumbum.commands.ProcessExecutionError/home/tkloczko/rpmbuild/BUILD/plumbum-1.8.2/plumbum/commands/base.py:docstring of plumbum.commands.base.Pipeline.popen:5: WARNING: py:class reference target not found: plumbum.commands.BG/home/tkloczko/rpmbuild/BUILD/plumbum-1.8.2/plumbum/commands/base.py:docstring of plumbum.commands.base.BaseRedirection.popen:5: WARNING: py:class reference target not found: plumbum.commands.BG/home/tkloczko/rpmbuild/BUILD/plumbum-1.8.2/plumbum/commands/base.py:docstring of plumbum.commands.base.BoundCommand.popen:5: WARNING: py:class reference target not found: plumbum.commands.BG/home/tkloczko/rpmbuild/BUILD/plumbum-1.8.2/plumbum/commands/base.py:docstring of plumbum.commands.base.BoundEnvCommand.popen:5: WARNING: py:class reference target not found: plumbum.commands.BG/home/tkloczko/rpmbuild/BUILD/plumbum-1.8.2/plumbum/commands/base.py:docstring of plumbum.commands.base.ConcreteCommand.popen:5: WARNING: py:class reference target not found: plumbum.commands.BG/home/tkloczko/rpmbuild/BUILD/plumbum-1.8.2/plumbum/commands/base.py:docstring of plumbum.commands.base.StdinDataRedirection.popen:5: WARNING: py:class reference target not found: plumbum.commands.BG/home/tkloczko/rpmbuild/BUILD/plumbum-1.8.2/plumbum/commands/modifiers.py:docstring of plumbum.commands.modifiers.Future.wait:1: WARNING: py:class reference target not found: plumbum.commands.ProcessExecutionError/home/tkloczko/rpmbuild/BUILD/plumbum-1.8.2/plumbum/commands/processes.py:docstring of plumbum.commands.processes.ProcessExecutionError:1: WARNING: py:func reference target not found: plumbum.commands.run_proc/home/tkloczko/rpmbuild/BUILD/plumbum-1.8.2/plumbum/commands/processes.py:docstring of plumbum.commands.processes.ProcessTimedOut:1: WARNING: py:func reference target not found: plumbum.commands.run_proc/home/tkloczko/rpmbuild/BUILD/plumbum-1.8.2/plumbum/commands/processes.py:docstring of plumbum.commands.processes.ProcessLineTimedOut:1: WARNING: py:func reference target not found: plumbum.commands.iter_lines/home/tkloczko/rpmbuild/BUILD/plumbum-1.8.2/plumbum/commands/processes.py:docstring of plumbum.commands.processes.CommandNotFound:1: WARNING: py:func reference target not found: plumbum.machines.remote.RemoteMachine.which/home/tkloczko/rpmbuild/BUILD/plumbum-1.8.2/plumbum/commands/processes.py:docstring of plumbum.commands.processes.run_proc:10: WARNING: py:class reference target not found: plumbum.cli.ProcessTimedOut/home/tkloczko/rpmbuild/BUILD/plumbum-1.8.2/plumbum/commands/processes.py:docstring of plumbum.commands.processes.iter_lines:1: WARNING: py:class reference target not found: plumbum.commands.ProcessExecutionError/home/tkloczko/rpmbuild/BUILD/plumbum-1.8.2/plumbum/commands/processes.py:docstring of plumbum.commands.processes.iter_lines:17: WARNING: py:class reference target not found: plumbum.commands.ProcessLineTimedOut/home/tkloczko/rpmbuild/BUILD/plumbum-1.8.2/plumbum/machines/local.py:docstring of plumbum.commands.processes.iter_lines:1: WARNING: py:class reference target not found: plumbum.commands.ProcessExecutionError/home/tkloczko/rpmbuild/BUILD/plumbum-1.8.2/plumbum/machines/local.py:docstring of plumbum.commands.processes.iter_lines:17: WARNING: py:class reference target not found: plumbum.commands.ProcessLineTimedOut/home/tkloczko/rpmbuild/BUILD/plumbum-1.8.2/plumbum/machines/local.py:docstring of plumbum.machines.local.LocalCommand.popen:5: WARNING: py:class reference target not found: plumbum.commands.BG/home/tkloczko/rpmbuild/BUILD/plumbum-1.8.2/plumbum/machines/local.py:docstring of plumbum.machines.local.LocalMachine.which:1: WARNING: py:class reference target not found: plumbum.commands.CommandNotFound/home/tkloczko/rpmbuild/BUILD/plumbum-1.8.2/plumbum/machines/local.py:docstring of plumbum.machines.local.LocalMachine.which:9: WARNING: py:class reference target not found: plumbum.machines.local.LocalPath/home/tkloczko/rpmbuild/BUILD/plumbum-1.8.2/plumbum/machines/local.py:docstring of plumbum.machines.local.LocalMachine.session:1: WARNING: py:class reference target not found: plumbum.session.ShellSession/home/tkloczko/rpmbuild/BUILD/plumbum-1.8.2/plumbum/machines/session.py:docstring of plumbum.machines.session.ShellSessionError:1: WARNING: py:func reference target not found: plumbum.session.ShellSession.popen/home/tkloczko/rpmbuild/BUILD/plumbum-1.8.2/plumbum/machines/session.py:docstring of plumbum.machines.session.ShellSession:1: WARNING: py:class reference target not found: plumbum.machines.remote.SshMachine/home/tkloczko/rpmbuild/BUILD/plumbum-1.8.2/plumbum/machines/session.py:docstring of plumbum.machines.session.ShellSession.popen:4: WARNING: py:class reference target not found: plumbum.commands.BaseCommand/home/tkloczko/rpmbuild/BUILD/plumbum-1.8.2/plumbum/machines/session.py:docstring of plumbum.machines.session.ShellSession.popen:6: WARNING: py:class reference target not found: plumbum.session.SessionPopen/home/tkloczko/rpmbuild/BUILD/plumbum-1.8.2/plumbum/machines/session.py:docstring of plumbum.machines.session.ShellSession.run:3: WARNING: py:class reference target not found: plumbum.commands.BaseCommand/home/tkloczko/rpmbuild/BUILD/plumbum-1.8.2/plumbum/machines/remote.py:docstring of plumbum.machines.remote.RemoteCommand.popen:5: WARNING: py:class reference target not found: plumbum.commands.BG/home/tkloczko/rpmbuild/BUILD/plumbum-1.8.2/plumbum/machines/remote.py:docstring of plumbum.machines.remote.RemoteCommand.popen:5: WARNING: py:class reference target not found: plumbum.commands.BG/home/tkloczko/rpmbuild/BUILD/plumbum-1.8.2/plumbum/machines/remote.py:docstring of plumbum.machines.remote.BaseRemoteMachine.which:1: WARNING: py:class reference target not found: plumbum.commands.CommandNotFound/home/tkloczko/rpmbuild/BUILD/plumbum-1.8.2/plumbum/machines/remote.py:docstring of plumbum.machines.remote.BaseRemoteMachine.which:9: WARNING: py:class reference target not found: plumbum.path.local.RemotePath/home/tkloczko/rpmbuild/BUILD/plumbum-1.8.2/plumbum/machines/remote.py:docstring of plumbum.machines.remote.BaseRemoteMachine.session:1: WARNING: py:class reference target not found: plumbum.session.ShellSession/home/tkloczko/rpmbuild/BUILD/plumbum-1.8.2/plumbum/machines/remote.py:docstring of plumbum.machines.remote.BaseRemoteMachine.download:1: WARNING: py:class reference target not found: plumbum.machines.local.LocalPath/home/tkloczko/rpmbuild/BUILD/plumbum-1.8.2/plumbum/machines/remote.py:docstring of plumbum.machines.remote.BaseRemoteMachine.upload:1: WARNING: py:class reference target not found: plumbum.machines.local.LocalPath/home/tkloczko/rpmbuild/BUILD/plumbum-1.8.2/plumbum/machines/ssh_machine.py:docstring of plumbum.machines.ssh_machine.SshTunnel:1: WARNING: py:func reference target not found: plumbum.machines.remote.SshMachine.tunnel/home/tkloczko/rpmbuild/BUILD/plumbum-1.8.2/plumbum/machines/ssh_machine.py:docstring of plumbum.machines.ssh_machine.SshMachine.session:1: WARNING: py:class reference target not found: plumbum.session.ShellSession/home/tkloczko/rpmbuild/BUILD/plumbum-1.8.2/plumbum/machines/ssh_machine.py:docstring of plumbum.machines.ssh_machine.SshMachine.tunnel:1: WARNING: py:class reference target not found: plumbum.machines.remote.SshTunnel/home/tkloczko/rpmbuild/BUILD/plumbum-1.8.2/plumbum/machines/ssh_machine.py:docstring of plumbum.machines.ssh_machine.SshMachine.download:1: WARNING: py:class reference target not found: plumbum.machines.local.LocalPath/home/tkloczko/rpmbuild/BUILD/plumbum-1.8.2/plumbum/machines/ssh_machine.py:docstring of plumbum.machines.ssh_machine.SshMachine.upload:1: WARNING: py:class reference target not found: plumbum.machines.local.LocalPath/home/tkloczko/rpmbuild/BUILD/plumbum-1.8.2/plumbum/machines/ssh_machine.py:docstring of plumbum.machines.ssh_machine.PuttyMachine:4: WARNING: py:class reference target not found: plumbum.machines.remote.SshMachine/home/tkloczko/rpmbuild/BUILD/plumbum-1.8.2/plumbum/machines/ssh_machine.py:docstring of plumbum.machines.ssh_machine.PuttyMachine.session:1: WARNING: py:class reference target not found: plumbum.session.ShellSession/home/tkloczko/rpmbuild/BUILD/plumbum-1.8.2/plumbum/machines/paramiko_machine.py:docstring of plumbum.machines.paramiko_machine.ParamikoMachine.session:1: WARNING: py:class reference target not found: plumbum.session.ShellSession/home/tkloczko/rpmbuild/BUILD/plumbum-1.8.2/plumbum/machines/paramiko_machine.py:docstring of plumbum.machines.paramiko_machine.ParamikoMachine.download:1: WARNING: py:class reference target not found: plumbum.machines.local.LocalPath/home/tkloczko/rpmbuild/BUILD/plumbum-1.8.2/plumbum/machines/paramiko_machine.py:docstring of plumbum.machines.paramiko_machine.ParamikoMachine.upload:1: WARNING: py:class reference target not found: plumbum.machines.local.LocalPath/home/tkloczko/rpmbuild/BUILD/plumbum-1.8.2/plumbum/path/base.py:docstring of plumbum.path.base.Path:1: WARNING: py:class reference target not found: plumbum.machines.local.LocalPath/home/tkloczko/rpmbuild/BUILD/plumbum-1.8.2/plumbum/path/base.py:docstring of plumbum.path.base.Path.__truediv__:1: WARNING: py:class reference target not found: plumbum.path.base._PathImpl/home/tkloczko/rpmbuild/BUILD/plumbum-1.8.2/plumbum/path/base.py:docstring of plumbum.path.base.Path.dirname:1: WARNING: py:class reference target not found: plumbum.path.base._PathImpl/home/tkloczko/rpmbuild/BUILD/plumbum-1.8.2/plumbum/path/base.py:docstring of plumbum.path.base.Path.uid:1: WARNING: py:class reference target not found: plumbum.path.FSUser/home/tkloczko/rpmbuild/BUILD/plumbum-1.8.2/plumbum/path/base.py:docstring of plumbum.path.base.Path.gid:1: WARNING: py:class reference target not found: plumbum.path.FSUser/home/tkloczko/rpmbuild/BUILD/plumbum-1.8.2/plumbum/path/base.py:docstring of plumbum.path.base.Path.join:1: WARNING: py:class reference target not found: plumbum.path.base._PathImpl/home/tkloczko/rpmbuild/BUILD/plumbum-1.8.2/plumbum/path/base.py:docstring of plumbum.path.base.Path.list:1: WARNING: py:class reference target not found: plumbum.path.base._PathImpl/home/tkloczko/rpmbuild/BUILD/plumbum-1.8.2/plumbum/path/base.py:docstring of plumbum.path.base.Path.iterdir:1: WARNING: py:class reference target not found: plumbum.path.base._PathImpl/home/tkloczko/rpmbuild/BUILD/plumbum-1.8.2/plumbum/path/base.py:docstring of plumbum.path.base.Path.stat:1: WARNING: py:class reference target not found: os.stat_result/home/tkloczko/rpmbuild/BUILD/plumbum-1.8.2/plumbum/path/base.py:docstring of plumbum.path.base.Path.with_name:1: WARNING: py:class reference target not found: plumbum.path.base._PathImpl/home/tkloczko/rpmbuild/BUILD/plumbum-1.8.2/plumbum/path/base.py:docstring of plumbum.path.base.Path.with_suffix:1: WARNING: py:class reference target not found: plumbum.path.base._PathImpl/home/tkloczko/rpmbuild/BUILD/plumbum-1.8.2/plumbum/path/base.py:docstring of plumbum.path.base.Path.glob:1: WARNING: py:class reference target not found: plumbum.path.base._PathImpl/home/tkloczko/rpmbuild/BUILD/plumbum-1.8.2/plumbum/path/base.py:docstring of plumbum.path.base.Path.open:1: WARNING: py:class reference target not found: io.IOBase/home/tkloczko/rpmbuild/BUILD/plumbum-1.8.2/plumbum/path/local.py:docstring of plumbum.path.local.LocalPath.uid:1: WARNING: py:class reference target not found: plumbum.path.FSUser/home/tkloczko/rpmbuild/BUILD/plumbum-1.8.2/plumbum/path/local.py:docstring of plumbum.path.local.LocalPath.gid:1: WARNING: py:class reference target not found: plumbum.path.FSUser/home/tkloczko/rpmbuild/BUILD/plumbum-1.8.2/plumbum/path/remote.py:docstring of plumbum.path.remote.RemotePath.uid:1: WARNING: py:class reference target not found: plumbum.path.FSUser/home/tkloczko/rpmbuild/BUILD/plumbum-1.8.2/plumbum/path/remote.py:docstring of plumbum.path.remote.RemotePath.gid:1: WARNING: py:class reference target not found: plumbum.path.FSUser/home/tkloczko/rpmbuild/BUILD/plumbum-1.8.2/plumbum/fs/atomic.py:docstring of plumbum.fs.atomic.PidFile.acquire:1: WARNING: py:class reference target not found: plumbum.atomic.PidFileTaken/home/tkloczko/rpmbuild/BUILD/plumbum-1.8.2/plumbum/fs/mounts.py:docstring of plumbum.fs.mounts.mount_table:1: WARNING: py:class reference target not found: plumbum.unixutils.MountEntrydonebuild succeeded, 94 warnings.
First of all currently it is not possible to use straight
sphinx-build
command to build documentation out of source treeThis can be fixed by patch like below:
This 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
Than .. on building my packages I'm using
sphinx-build
command with-n
switch which shows warmings about missing references. These are not critical issues.Here is sphinx output with warnings:
You can peak on fixes that kind of issues in other projects
RDFLib/rdflib-sqlalchemy#95
RDFLib/rdflib#2036
click-contrib/sphinx-click@abc31069
frostming/unearth#14
jaraco/cssutils#21
latchset/jwcrypto#289
latchset/jwcrypto#289
pypa/distlib@98b9b89f
pywbem/pywbem#2895
sissaschool/elementpath@bf869d9e
sissaschool/xmlschema@42ea98f2
sqlalchemy/sqlalchemy@5e88e6e8
The text was updated successfully, but these errors were encountered: