jaraco / jaraco.packaging

MIT License
4 stars 4 forks source link

Warning in docs build for 9.3.0 #13

Closed jaraco closed 6 months ago

jaraco commented 1 year ago
          Tested and still it is one small warning 😋 
+ /usr/bin/sphinx-build -n -T -b man docs build/sphinx/man
Running Sphinx v6.2.1
making output directory... done
building [mo]: targets for 0 po files that are out of date
writing output...
building [man]: all manpages
updating environment: [new config] 2 added, 0 changed, 0 removed
reading sources... [ 50%] history
reading sources... [100%] index

looking for now-outdated files... none found
pickling environment... done
checking consistency... done
writing... python-jaraco-packaging.3 { history } /home/tkloczko/rpmbuild/BUILD/jaraco.packaging-9.3.0/jaraco/packaging/sphinx.py:docstring of jaraco.packaging.sphinx.SidebarLinksDirective:1: WARNING: py:class reference target not found: sphinx.util.docutils.SphinxDirective
done
build succeeded, 1 warning.

Originally posted by @kloczek in https://github.com/jaraco/jaraco.packaging/issues/12#issuecomment-1623070953

jaraco commented 1 year ago

I don't understand. Since b5bfdb14bdf14f0a8a93f1ebcf9632ab31ff027b, I don't get that warning when building the docs:

 jaraco.packaging main @ tox -e docs
.pkg: _optional_hooks> python /Users/jaraco/.local/pipx/venvs/tox/lib/python3.11/site-packages/pyproject_api/_backend.py True setuptools.build_meta
.pkg: get_requires_for_build_editable> python /Users/jaraco/.local/pipx/venvs/tox/lib/python3.11/site-packages/pyproject_api/_backend.py True setuptools.build_meta
.pkg: build_editable> python /Users/jaraco/.local/pipx/venvs/tox/lib/python3.11/site-packages/pyproject_api/_backend.py True setuptools.build_meta
docs: install_package> python -I -m pip install --force-reinstall --no-deps .tox/.tmp/package/32/jaraco.packaging-9.3.1.dev3+gb8cefc3-0.editable-py3-none-any.whl
docs: commands[0] /Users/jaraco/code/jaraco/jaraco.packaging/docs> python -m sphinx -W --keep-going . /Users/jaraco/code/jaraco/jaraco.packaging/build/html
Running Sphinx v7.0.1
loading pickled environment... done
/Users/jaraco/code/jaraco/jaraco.packaging/.tox/docs/lib/python3.11/site-packages/build/env.py:201: EncodingWarning: 'encoding' argument not specified
  with tempfile.NamedTemporaryFile('w+', prefix='build-reqs-', suffix='.txt', delete=False) as req_file:
building [mo]: targets for 0 po files that are out of date
writing output... 
building [html]: targets for 0 source files that are out of date
updating environment: [config changed ('project')] 2 added, 0 changed, 0 removed
reading sources... [100%] index                                                                                                                                        
looking for now-outdated files... none found
pickling environment... done
checking consistency... done
preparing documents... done
writing output... [100%] index                                                                                                                                         
generating indices... genindex py-modindex done
writing additional pages... search done
copying static files... done
copying extra files... done
dumping search index in English (code: en)... done
dumping object inventory... done
build succeeded.

The HTML pages are in ../build/html.
docs: commands[1] /Users/jaraco/code/jaraco/jaraco.packaging/docs> python -m sphinxlint
/Users/jaraco/code/jaraco/jaraco.packaging/.tox/docs/lib/python3.11/site-packages/regex/regex.py:470: EncodingWarning: UTF-8 Mode affects locale.getpreferredencoding(). Consider locale.getencoding() instead.
  pattern_locale = _getpreferredencoding()
No problems found.
.pkg: _exit> python /Users/jaraco/.local/pipx/venvs/tox/lib/python3.11/site-packages/pyproject_api/_backend.py True setuptools.build_meta
  docs: OK (4.51=setup[0.98]+cmd[3.42,0.11] seconds)
  congratulations :) (4.57 seconds)
jaraco commented 1 year ago

I suspect something about your build process isn't honoring the intersphinx link.