RDFLib / rdflib-sqlalchemy

RDFLib store using SQLAlchemy dbapi as back-end
Other
145 stars 34 forks source link

0.5.3: sphinx warnings `reference target not found` #95

Closed kloczek closed 2 years ago

kloczek commented 2 years ago

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:

```console + /usr/bin/sphinx-build -n -T -b man docs build/sphinx/man Running Sphinx v4.5.0 Creating file api/rdflib_sqlalchemy.rst. Creating file api/rdflib_sqlalchemy.base.rst. Creating file api/rdflib_sqlalchemy.constants.rst. Creating file api/rdflib_sqlalchemy.sql.rst. Creating file api/rdflib_sqlalchemy.statistics.rst. Creating file api/rdflib_sqlalchemy.store.rst. Creating file api/rdflib_sqlalchemy.tables.rst. Creating file api/rdflib_sqlalchemy.termutils.rst. Creating file api/rdflib_sqlalchemy.types.rst. Creating file api/modules.rst. making output directory... done loading intersphinx inventory from https://docs.python.org/3/objects.inv... loading intersphinx inventory from https://rdflib.readthedocs.io/en/stable/objects.inv... building [mo]: targets for 0 po files that are out of date building [man]: all manpages updating environment: [new config] 11 added, 0 changed, 0 removed reading sources... [100%] index looking for now-outdated files... none found pickling environment... done checking consistency... done writing... python-rdflib-sqlalchemy.3 { api/modules api/rdflib_sqlalchemy api/rdflib_sqlalchemy.base api/rdflib_sqlalchemy.constants api/rdflib_sqlalchemy.sql api/rdflib_sqlalchemy.statistics api/rdflib_sqlalchemy.store api/rdflib_sqlalchemy.tables api/rdflib_sqlalchemy.termutils api/rdflib_sqlalchemy.types } /home/tkloczko/rpmbuild/BUILD/rdflib-sqlalchemy-0.5.3/rdflib_sqlalchemy/sql.py:docstring of rdflib_sqlalchemy.sql.union_select:: WARNING: py:class reference target not found: iterable of tuples /home/tkloczko/rpmbuild/BUILD/rdflib-sqlalchemy-0.5.3/rdflib_sqlalchemy/sql.py:docstring of rdflib_sqlalchemy.sql.union_select:8: WARNING: py:obj reference target not found: COUNT_SELECT /home/tkloczko/rpmbuild/BUILD/rdflib-sqlalchemy-0.5.3/rdflib_sqlalchemy/sql.py:docstring of rdflib_sqlalchemy.sql.union_select:8: WARNING: py:obj reference target not found: CONTEXT_SELECT /home/tkloczko/rpmbuild/BUILD/rdflib-sqlalchemy-0.5.3/rdflib_sqlalchemy/sql.py:docstring of rdflib_sqlalchemy.sql.union_select:8: WARNING: py:obj reference target not found: TRIPLE_SELECT /home/tkloczko/rpmbuild/BUILD/rdflib-sqlalchemy-0.5.3/rdflib_sqlalchemy/statistics.py:docstring of rdflib_sqlalchemy.statistics.get_group_by_count:3: WARNING: py:obj reference target not found: Session /home/tkloczko/rpmbuild/BUILD/rdflib-sqlalchemy-0.5.3/rdflib_sqlalchemy/statistics.py:docstring of rdflib_sqlalchemy.statistics.get_group_by_count:3: WARNING: py:obj reference target not found: Column /home/tkloczko/rpmbuild/BUILD/rdflib-sqlalchemy-0.5.3/rdflib_sqlalchemy/store.py:docstring of rdflib_sqlalchemy.store.SQLAlchemy:1: WARNING: py:class reference target not found: rdflib_sqlalchemy.statistics.StatisticsMixin /home/tkloczko/rpmbuild/BUILD/rdflib-sqlalchemy-0.5.3/rdflib_sqlalchemy/store.py:docstring of rdflib_sqlalchemy.store.SQLAlchemy:: WARNING: py:class reference target not found: sqlalchemy.engine.Engine /home/tkloczko/rpmbuild/BUILD/rdflib-sqlalchemy-0.5.3/rdflib_sqlalchemy/store.py:docstring of rdflib_sqlalchemy.store.SQLAlchemy:: WARNING: py:class reference target not found: optional /home/tkloczko/rpmbuild/BUILD/rdflib-sqlalchemy-0.5.3/rdflib_sqlalchemy/store.py:docstring of rdflib_sqlalchemy.store.SQLAlchemy:23: WARNING: py:obj reference target not found: SQLAlchemy.engine.Engine /home/tkloczko/rpmbuild/BUILD/rdflib-sqlalchemy-0.5.3/rdflib_sqlalchemy/store.py:docstring of rdflib_sqlalchemy.store.SQLAlchemy.open:3: WARNING: py:obj reference target not found: **kwargs /home/tkloczko/rpmbuild/BUILD/rdflib-sqlalchemy-0.5.3/rdflib_sqlalchemy/types.py:docstring of rdflib_sqlalchemy.types.TermType:1: WARNING: py:class reference target not found: sqlalchemy.sql.type_api.TypeDecorator /home/tkloczko/rpmbuild/BUILD/rdflib-sqlalchemy-0.5.3/rdflib_sqlalchemy/types.py:docstring of rdflib_sqlalchemy.types.TermType:3: WARNING: py:class reference target not found: TypeDecorator done build succeeded, 13 warnings. ```

You can peak on fixes that kind of issues in other projects https://github.com/latchset/jwcrypto/pull/289 https://github.com/click-contrib/sphinx-click/commit/abc31069 https://github.com/latchset/jwcrypto/pull/289

mwatts15 commented 2 years ago

Thanks! Addressed in develop branch.

kloczek commented 2 years ago

Thank you. Just tested those two commits 6dad2e75 10722ef3. Still I see some warnings 😋

```console + /usr/bin/sphinx-build -n -T -b man docs build/sphinx/man Running Sphinx v4.5.0 Creating file api/rdflib_sqlalchemy.rst. Creating file api/rdflib_sqlalchemy.base.rst. Creating file api/rdflib_sqlalchemy.constants.rst. Creating file api/rdflib_sqlalchemy.sql.rst. Creating file api/rdflib_sqlalchemy.statistics.rst. Creating file api/rdflib_sqlalchemy.store.rst. Creating file api/rdflib_sqlalchemy.tables.rst. Creating file api/rdflib_sqlalchemy.termutils.rst. Creating file api/rdflib_sqlalchemy.types.rst. Creating file api/modules.rst. making output directory... done loading intersphinx inventory from https://docs.python.org/3/objects.inv... loading intersphinx inventory from https://rdflib.readthedocs.io/en/stable/objects.inv... loading intersphinx inventory from https://docs.sqlalchemy.org/en/14/objects.inv... building [mo]: targets for 0 po files that are out of date building [man]: all manpages updating environment: [new config] 11 added, 0 changed, 0 removed reading sources... [100%] index looking for now-outdated files... none found pickling environment... done checking consistency... done writing... python-rdflib-sqlalchemy.3 { api/modules api/rdflib_sqlalchemy api/rdflib_sqlalchemy.base api/rdflib_sqlalchemy.constants api/rdflib_sqlalchemy.sql api/rdflib_sqlalchemy.statistics api/rdflib_sqlalchemy.store api/rdflib_sqlalchemy.tables api/rdflib_sqlalchemy.termutils api/rdflib_sqlalchemy.types } /home/tkloczko/rpmbuild/BUILD/rdflib-sqlalchemy-0.5.3/rdflib_sqlalchemy/sql.py:docstring of rdflib_sqlalchemy.sql.union_select:: WARNING: py:class reference target not found: iterable of tuples /home/tkloczko/rpmbuild/BUILD/rdflib-sqlalchemy-0.5.3/rdflib_sqlalchemy/types.py:docstring of rdflib_sqlalchemy.types.TermType:3: WARNING: py:class reference target not found: TypeDecorator done build succeeded, 2 warnings. ```
mwatts15 commented 2 years ago

Oh, I know about those. I just don't think they matter.