y-crdt / ypy

Python bindings to y-crdt

Home Page:https://ypy.readthedocs.io/en/latest/

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

0.6.1: sphinx warnings `reference target not found`

kloczek opened this issue · comments

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:

+ /usr/bin/sphinx-build -n -T -b man docs build/sphinx/man
Running Sphinx v6.1.3
making output directory... done
WARNING: html_static_path entry '_static' does not exist
[AutoAPI] Reading files... [100%] /home/tkloczko/rpmbuild/BUILD/ypy-0.6.1/y_py.pyi
[AutoAPI] Mapping Data... [100%] /home/tkloczko/rpmbuild/BUILD/ypy-0.6.1/y_py.pyi
[AutoAPI] Rendering Data... [100%] y_py

[autosummary] generating autosummary for: index.rst, installation.rst, modules.rst, tutorial.rst
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
[AutoAPI] Adding AutoAPI TOCTree [autoapi/index] to index.rst
reading sources... [100%] tutorial
/home/tkloczko/rpmbuild/BUILD/ypy-0.6.1/docs/autoapi/y_py/index.rst:1: WARNING: Inline interpreted text or phrase reference start-string without end-string.
/home/tkloczko/rpmbuild/BUILD/ypy-0.6.1/docs/autoapi/y_py/index.rst:1: WARNING: Inline interpreted text or phrase reference start-string without end-string.
/home/tkloczko/rpmbuild/BUILD/ypy-0.6.1/docs/autoapi/y_py/index.rst:11: WARNING: Inline literal start-string without end-string.
/home/tkloczko/rpmbuild/BUILD/ypy-0.6.1/docs/autoapi/y_py/index.rst:831: ERROR: Unexpected indentation.
/home/tkloczko/rpmbuild/BUILD/ypy-0.6.1/docs/autoapi/y_py/index.rst:23: WARNING: Block quote ends without a blank line; unexpected unindent.
/home/tkloczko/rpmbuild/BUILD/ypy-0.6.1/docs/autoapi/y_py/index.rst:23: WARNING: Inline literal start-string without end-string.
/home/tkloczko/rpmbuild/BUILD/ypy-0.6.1/docs/autoapi/y_py/index.rst:23: WARNING: Inline interpreted text or phrase reference start-string without end-string.
/home/tkloczko/rpmbuild/BUILD/ypy-0.6.1/docs/index.rst:5: WARNING: toctree contains reference to nonexisting document 'license'
looking for now-outdated files... none found
pickling environment... done
checking consistency... /home/tkloczko/rpmbuild/BUILD/ypy-0.6.1/docs/autoapi/index.rst: WARNING: document isn't included in any toctree
/home/tkloczko/rpmbuild/BUILD/ypy-0.6.1/docs/modules.rst: WARNING: document isn't included in any toctree
done
writing... python-y-py.3 { installation tutorial autoapi/index autoapi/y_py/index } /home/tkloczko/rpmbuild/BUILD/ypy-0.6.1/docs/autoapi/y_py/index.rst:226: WARNING: py:class reference target not found: YDocUpdate
/home/tkloczko/rpmbuild/BUILD/ypy-0.6.1/docs/autoapi/y_py/index.rst:232: WARNING: py:class reference target not found: EncodedStateVector
/home/tkloczko/rpmbuild/BUILD/ypy-0.6.1/docs/autoapi/y_py/index.rst:255: WARNING: py:class reference target not found: EncodedStateVector
/home/tkloczko/rpmbuild/BUILD/ypy-0.6.1/docs/autoapi/y_py/index.rst:255: WARNING: py:class reference target not found: YDocUpdate
/home/tkloczko/rpmbuild/BUILD/ypy-0.6.1/docs/autoapi/y_py/index.rst:277: WARNING: py:class reference target not found: YDocUpdate
/home/tkloczko/rpmbuild/BUILD/ypy-0.6.1/docs/autoapi/y_py/index.rst:356: WARNING: py:class reference target not found: EncodedStateVector
/home/tkloczko/rpmbuild/BUILD/ypy-0.6.1/docs/autoapi/y_py/index.rst:385: WARNING: py:class reference target not found: EncodedStateVector
/home/tkloczko/rpmbuild/BUILD/ypy-0.6.1/docs/autoapi/y_py/index.rst:385: WARNING: py:class reference target not found: YDocUpdate
/home/tkloczko/rpmbuild/BUILD/ypy-0.6.1/docs/autoapi/y_py/index.rst:413: WARNING: py:class reference target not found: YDocUpdate
/home/tkloczko/rpmbuild/BUILD/ypy-0.6.1/docs/autoapi/y_py/index.rst:532: WARNING: py:class reference target not found: Event
/home/tkloczko/rpmbuild/BUILD/ypy-0.6.1/docs/autoapi/y_py/index.rst:865: WARNING: py:class reference target not found: Event
/home/tkloczko/rpmbuild/BUILD/ypy-0.6.1/docs/autoapi/y_py/index.rst:1061: WARNING: py:class reference target not found: Event
/home/tkloczko/rpmbuild/BUILD/ypy-0.6.1/docs/autoapi/y_py/index.rst:1364: WARNING: py:class reference target not found: YXmlAttributes
/home/tkloczko/rpmbuild/BUILD/ypy-0.6.1/docs/autoapi/y_py/index.rst:1370: WARNING: py:class reference target not found: YXmlTreeWalker
/home/tkloczko/rpmbuild/BUILD/ypy-0.6.1/docs/autoapi/y_py/index.rst:1386: WARNING: py:class reference target not found: Event
/home/tkloczko/rpmbuild/BUILD/ypy-0.6.1/docs/autoapi/y_py/index.rst:1470: WARNING: py:class reference target not found: YXmlAttributes
/home/tkloczko/rpmbuild/BUILD/ypy-0.6.1/docs/autoapi/y_py/index.rst:1488: WARNING: py:class reference target not found: Event
done
build succeeded, 28 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