-
Notifications
You must be signed in to change notification settings - Fork 2
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
1.2.6: sphinx warnings reference target not found
#18
Comments
Can this be run inside the venv - using |
Yes it can be however with patch which provided nullifies necessity of such procedure. |
It modifies the sys path - it wouldn't be able to include any possible dependencies or account for changes to the layout/build-system. |
|
Ok, just keep in mind this package contains a sphinx plugin used in the documentation of this project. It should work, but may cause issues in the future |
You would need sphinx_rtd_theme, tabulate, and sphinx_autodoc_typehints to build it out of the venv currently. |
Just tested 1.3.1 and issue with alter sphinx output:+ /usr/bin/sphinx-build -n -T -b man docs build/sphinx/man
Running Sphinx v7.1.2
[autosummary] generating autosummary for: api.rst, command_line.rst, documentation.rst, global_configuration.rst, index.rst, pydantic.rst, universal_config.rst
[autosummary] generating autosummary for: /home/tkloczko/rpmbuild/BUILD/pytoolconfig-1.3.1/docs/generated/pytoolconfig.PyToolConfig.rst, /home/tkloczko/rpmbuild/BUILD/pytoolconfig-1.3.1/docs/generated/pytoolconfig.rst, /home/tkloczko/rpmbuild/BUILD/pytoolconfig-1.3.1/docs/generated/pytoolconfig.sources.IniConfig.rst, /home/tkloczko/rpmbuild/BUILD/pytoolconfig-1.3.1/docs/generated/pytoolconfig.sources.PyProject.rst, /home/tkloczko/rpmbuild/BUILD/pytoolconfig-1.3.1/docs/generated/pytoolconfig.sources.PyTool.rst, /home/tkloczko/rpmbuild/BUILD/pytoolconfig-1.3.1/docs/generated/pytoolconfig.sources.SetupConfig.rst, /home/tkloczko/rpmbuild/BUILD/pytoolconfig-1.3.1/docs/generated/pytoolconfig.sources.Source.rst
loading intersphinx inventory from https://docs.python.org/3/objects.inv...
building [mo]: targets for 0 po files that are out of date
writing output...
building [man]: all manpages
updating environment: [new config] 14 added, 0 changed, 0 removed
reading sources... [100%] universal_config
looking for now-outdated files... none found
pickling environment... done
checking consistency... done
writing... python-pytoolconfig.3 { command_line universal_config documentation global_configuration pydantic api generated/pytoolconfig generated/pytoolconfig.PyToolConfig generated/pytoolconfig.sources.Source generated/pytoolconfig.sources.IniConfig generated/pytoolconfig.sources.SetupConfig generated/pytoolconfig.sources.PyProject generated/pytoolconfig.sources.PyTool } /home/tkloczko/rpmbuild/BUILD/pytoolconfig-1.3.1/docs/generated/pytoolconfig.PyToolConfig.rst:22:<autosummary>:1: WARNING: py:obj reference target not found: pytoolconfig.PyToolConfig.parse
/home/tkloczko/rpmbuild/BUILD/pytoolconfig-1.3.1/docs/generated/pytoolconfig.PyToolConfig.rst:32:<autosummary>:1: WARNING: py:obj reference target not found: pytoolconfig.PyToolConfig.arg_parser
/home/tkloczko/rpmbuild/BUILD/pytoolconfig-1.3.1/docs/generated/pytoolconfig.PyToolConfig.rst:32:<autosummary>:1: WARNING: py:obj reference target not found: pytoolconfig.PyToolConfig.fall_through
/home/tkloczko/rpmbuild/BUILD/pytoolconfig-1.3.1/docs/generated/pytoolconfig.PyToolConfig.rst:32:<autosummary>:1: WARNING: py:obj reference target not found: pytoolconfig.PyToolConfig.sources
/home/tkloczko/rpmbuild/BUILD/pytoolconfig-1.3.1/docs/generated/pytoolconfig.PyToolConfig.rst:32:<autosummary>:1: WARNING: py:obj reference target not found: pytoolconfig.PyToolConfig.tool
/home/tkloczko/rpmbuild/BUILD/pytoolconfig-1.3.1/docs/generated/pytoolconfig.PyToolConfig.rst:32:<autosummary>:1: WARNING: py:obj reference target not found: pytoolconfig.PyToolConfig.working_directory
/home/tkloczko/rpmbuild/BUILD/pytoolconfig-1.3.1/docs/generated/pytoolconfig.PyToolConfig.rst:32:<autosummary>:1: WARNING: py:obj reference target not found: pytoolconfig.PyToolConfig.model
/home/tkloczko/rpmbuild/BUILD/pytoolconfig-1.3.1/docs/generated/pytoolconfig.sources.Source.rst:22:<autosummary>:1: WARNING: py:obj reference target not found: pytoolconfig.sources.Source.parse
/home/tkloczko/rpmbuild/BUILD/pytoolconfig-1.3.1/docs/generated/pytoolconfig.sources.Source.rst:28:<autosummary>:1: WARNING: py:obj reference target not found: pytoolconfig.sources.Source.name
/home/tkloczko/rpmbuild/BUILD/pytoolconfig-1.3.1/docs/generated/pytoolconfig.sources.Source.rst:28:<autosummary>:1: WARNING: py:obj reference target not found: pytoolconfig.sources.Source.description
/home/tkloczko/rpmbuild/BUILD/pytoolconfig-1.3.1/docs/generated/pytoolconfig.sources.IniConfig.rst:22:<autosummary>:1: WARNING: py:obj reference target not found: pytoolconfig.sources.IniConfig.parse
/home/tkloczko/rpmbuild/BUILD/pytoolconfig-1.3.1/docs/generated/pytoolconfig.sources.IniConfig.rst:28:<autosummary>:1: WARNING: py:obj reference target not found: pytoolconfig.sources.IniConfig.name
/home/tkloczko/rpmbuild/BUILD/pytoolconfig-1.3.1/docs/generated/pytoolconfig.sources.IniConfig.rst:28:<autosummary>:1: WARNING: py:obj reference target not found: pytoolconfig.sources.IniConfig.description
/home/tkloczko/rpmbuild/BUILD/pytoolconfig-1.3.1/docs/generated/pytoolconfig.sources.SetupConfig.rst:22:<autosummary>:1: WARNING: py:obj reference target not found: pytoolconfig.sources.SetupConfig.parse
/home/tkloczko/rpmbuild/BUILD/pytoolconfig-1.3.1/docs/generated/pytoolconfig.sources.SetupConfig.rst:28:<autosummary>:1: WARNING: py:obj reference target not found: pytoolconfig.sources.SetupConfig.description
/home/tkloczko/rpmbuild/BUILD/pytoolconfig-1.3.1/docs/generated/pytoolconfig.sources.SetupConfig.rst:28:<autosummary>:1: WARNING: py:obj reference target not found: pytoolconfig.sources.SetupConfig.name
/home/tkloczko/rpmbuild/BUILD/pytoolconfig-1.3.1/docs/generated/pytoolconfig.sources.PyProject.rst:23:<autosummary>:1: WARNING: py:obj reference target not found: pytoolconfig.sources.PyProject.parse
/home/tkloczko/rpmbuild/BUILD/pytoolconfig-1.3.1/docs/generated/pytoolconfig.sources.PyProject.rst:23:<autosummary>:1: WARNING: py:obj reference target not found: pytoolconfig.sources.PyProject.universalconfig
/home/tkloczko/rpmbuild/BUILD/pytoolconfig-1.3.1/docs/generated/pytoolconfig.sources.PyProject.rst:32:<autosummary>:1: WARNING: py:obj reference target not found: pytoolconfig.sources.PyProject.description
/home/tkloczko/rpmbuild/BUILD/pytoolconfig-1.3.1/docs/generated/pytoolconfig.sources.PyProject.rst:32:<autosummary>:1: WARNING: py:obj reference target not found: pytoolconfig.sources.PyProject.name
/home/tkloczko/rpmbuild/BUILD/pytoolconfig-1.3.1/docs/generated/pytoolconfig.sources.PyProject.rst:32:<autosummary>:1: WARNING: py:obj reference target not found: pytoolconfig.sources.PyProject.toml_dict
/home/tkloczko/rpmbuild/BUILD/pytoolconfig-1.3.1/docs/generated/pytoolconfig.sources.PyProject.rst:32:<autosummary>:1: WARNING: py:obj reference target not found: pytoolconfig.sources.PyProject.tool
/home/tkloczko/rpmbuild/BUILD/pytoolconfig-1.3.1/docs/generated/pytoolconfig.sources.PyProject.rst:32:<autosummary>:1: WARNING: py:obj reference target not found: pytoolconfig.sources.PyProject.file
/home/tkloczko/rpmbuild/BUILD/pytoolconfig-1.3.1/docs/generated/pytoolconfig.sources.PyTool.rst:23:<autosummary>:1: WARNING: py:obj reference target not found: pytoolconfig.sources.PyTool.parse
/home/tkloczko/rpmbuild/BUILD/pytoolconfig-1.3.1/docs/generated/pytoolconfig.sources.PyTool.rst:23:<autosummary>:1: WARNING: py:obj reference target not found: pytoolconfig.sources.PyTool.universalconfig
/home/tkloczko/rpmbuild/BUILD/pytoolconfig-1.3.1/docs/generated/pytoolconfig.sources.PyTool.rst:32:<autosummary>:1: WARNING: py:obj reference target not found: pytoolconfig.sources.PyTool.description
/home/tkloczko/rpmbuild/BUILD/pytoolconfig-1.3.1/docs/generated/pytoolconfig.sources.PyTool.rst:32:<autosummary>:1: WARNING: py:obj reference target not found: pytoolconfig.sources.PyTool.name
/home/tkloczko/rpmbuild/BUILD/pytoolconfig-1.3.1/docs/generated/pytoolconfig.sources.PyTool.rst:32:<autosummary>:1: WARNING: py:obj reference target not found: pytoolconfig.sources.PyTool.toml_dict
/home/tkloczko/rpmbuild/BUILD/pytoolconfig-1.3.1/docs/generated/pytoolconfig.sources.PyTool.rst:32:<autosummary>:1: WARNING: py:obj reference target not found: pytoolconfig.sources.PyTool.tool
/home/tkloczko/rpmbuild/BUILD/pytoolconfig-1.3.1/docs/generated/pytoolconfig.sources.PyTool.rst:32:<autosummary>:1: WARNING: py:obj reference target not found: pytoolconfig.sources.PyTool.file
done
build succeeded, 30 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 the 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: