MagicStack / MagicStack/asyncpg

0.25.0: sphinx warnings `reference target not found`

Abierto
#928 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Lenguaje dominante
Python
Estrellas
8.1k
Forks
468
Métricas de merge de PR
Sin PR fusionados en 30 d

Descripción

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
[tkloczko@devel-g2v asyncpg-0.25.0]$ PYTHONPATH=$PWD/build/$(cd build; ls -d1 lib*) /usr/bin/sphinx-build -n -T -b man docs build/sphinx/man
Running Sphinx v5.0.2
WARNING: Invalid configuration value found: 'language = None'. Update your configuration to a valid langauge code. Falling back to 'en' (English).
loading pickled environment... done
building [mo]: targets for 0 po files that are out of date
building [man]: all manpages
updating environment: 0 added, 1 changed, 0 removed
reading sources... [100%] api/index
WARNING: autodoc: failed to import function 'connection.connect' from module 'asyncpg'; the following exception was raised:
No module named 'asyncpg.protocol.protocol'
WARNING: autodoc: failed to import class 'connection.Connection' from module 'asyncpg'; the following exception was raised:
No module named 'asyncpg.protocol.protocol'
WARNING: autodoc: failed to import class 'prepared_stmt.PreparedStatement' from module 'asyncpg'; the following exception was raised:
No module named 'asyncpg.protocol.protocol'
WARNING: autodoc: failed to import class 'transaction.Transaction' from module 'asyncpg'; the following exception was raised:
No module named 'asyncpg.protocol.protocol'
WARNING: autodoc: failed to import class 'cursor.CursorFactory' from module 'asyncpg'; the following exception was raised:
No module named 'asyncpg.protocol.protocol'
WARNING: autodoc: failed to import class 'cursor.Cursor' from module 'asyncpg'; the following exception was raised:
No module named 'asyncpg.protocol.protocol'
WARNING: autodoc: failed to import function 'pool.create_pool' from module 'asyncpg'; the following exception was raised:
No module named 'asyncpg.protocol.protocol'
WARNING: autodoc: failed to import class 'pool.Pool' from module 'asyncpg'; the following exception was raised:
No module named 'asyncpg.protocol.protocol'
WARNING: autodoc: failed to import module 'types' from module 'asyncpg'; the following exception was raised:
No module named 'asyncpg.protocol.protocol'
looking for now-outdated files... none found
pickling environment... done
checking consistency... done
writing... python-asyncpg.3 { installation usage api/index faq } /home/tkloczko/rpmbuild/BUILD/asyncpg-0.25.0/docs/usage.rst:7: WARNING: py:func reference target not found: asyncpg.connection.connect
/home/tkloczko/rpmbuild/BUILD/asyncpg-0.25.0/docs/usage.rst:7: WARNING: py:class reference target not found: asyncpg.connection.Connection
/home/tkloczko/rpmbuild/BUILD/asyncpg-0.25.0/docs/usage.rst:77: WARNING: py:class reference target not found: asyncpg.types.Range
/home/tkloczko/rpmbuild/BUILD/asyncpg-0.25.0/docs/usage.rst:80: WARNING: py:class reference target not found: asyncpg.types.Range
/home/tkloczko/rpmbuild/BUILD/asyncpg-0.25.0/docs/usage.rst:88: WARNING: py:class reference target not found: asyncpg.types.BitString
/home/tkloczko/rpmbuild/BUILD/asyncpg-0.25.0/docs/usage.rst:92: WARNING: py:class reference target not found: asyncpg.types.Box
/home/tkloczko/rpmbuild/BUILD/asyncpg-0.25.0/docs/usage.rst:117: WARNING: py:class reference target not found: asyncpg.types.Circle
/home/tkloczko/rpmbuild/BUILD/asyncpg-0.25.0/docs/usage.rst:147: WARNING: py:class reference target not found: asyncpg.types.Line
/home/tkloczko/rpmbuild/BUILD/asyncpg-0.25.0/docs/usage.rst:149: WARNING: py:class reference target not found: asyncpg.types.LineSegment
/home/tkloczko/rpmbuild/BUILD/asyncpg-0.25.0/docs/usage.rst:154: WARNING: py:class reference target not found: asyncpg.types.Path
/home/tkloczko/rpmbuild/BUILD/asyncpg-0.25.0/docs/usage.rst:156: WARNING: py:class reference target not found: asyncpg.types.Point
/home/tkloczko/rpmbuild/BUILD/asyncpg-0.25.0/docs/usage.rst:158: WARNING: py:class reference target not found: asyncpg.types.Polygon
/home/tkloczko/rpmbuild/BUILD/asyncpg-0.25.0/docs/usage.rst:182: WARNING: py:meth reference target not found: asyncpg.connection.Connection.set_type_codec
/home/tkloczko/rpmbuild/BUILD/asyncpg-0.25.0/docs/usage.rst:182: WARNING: py:meth reference target not found: asyncpg.connection.Connection.set_builtin_type_codec
/home/tkloczko/rpmbuild/BUILD/asyncpg-0.25.0/docs/usage.rst:314: WARNING: py:meth reference target not found: asyncpg.connection.Connection.set_builtin_type_codec
/home/tkloczko/rpmbuild/BUILD/asyncpg-0.25.0/docs/usage.rst:341: WARNING: py:meth reference target not found: asyncpg.connection.Connection
/home/tkloczko/rpmbuild/BUILD/asyncpg-0.25.0/docs/usage.rst:371: WARNING: py:func reference target not found: asyncpg.pool.create_pool
/home/tkloczko/rpmbuild/BUILD/asyncpg-0.25.0/docs/usage.rst:371: WARNING: py:class reference target not found: asyncpg.pool.Pool
/home/tkloczko/rpmbuild/BUILD/asyncpg-0.25.0/docs/api/index.rst:30: WARNING: py:meth reference target not found: Connection.prepare
/home/tkloczko/rpmbuild/BUILD/asyncpg-0.25.0/docs/api/index.rst:52: WARNING: py:meth reference target not found: Connection.fetch
/home/tkloczko/rpmbuild/BUILD/asyncpg-0.25.0/docs/api/index.rst:52: WARNING: py:meth reference target not found: Connection.fetchrow
/home/tkloczko/rpmbuild/BUILD/asyncpg-0.25.0/docs/api/index.rst:52: WARNING: py:meth reference target not found: Connection.fetchval
/home/tkloczko/rpmbuild/BUILD/asyncpg-0.25.0/docs/api/index.rst:117: WARNING: py:meth reference target not found: asyncpg.connection.Connection.transaction
/home/tkloczko/rpmbuild/BUILD/asyncpg-0.25.0/docs/api/index.rst:145: WARNING: py:meth reference target not found: asyncpg.connection.Connection.cursor
/home/tkloczko/rpmbuild/BUILD/asyncpg-0.25.0/docs/api/index.rst:203: WARNING: py:meth reference target not found: asyncpg.connection.Connection.cursor
/home/tkloczko/rpmbuild/BUILD/asyncpg-0.25.0/docs/api/index.rst:203: WARNING: py:meth reference target not found: asyncpg.prepared_stmt.PreparedStatement.cursor
/home/tkloczko/rpmbuild/BUILD/asyncpg-0.25.0/docs/api/index.rst:211: WARNING: py:meth reference target not found: asyncpg.connection.Connection.cursor
/home/tkloczko/rpmbuild/BUILD/asyncpg-0.25.0/docs/api/index.rst:211: WARNING: py:meth reference target not found: asyncpg.prepared_stmt.PreparedStatement.cursor
/home/tkloczko/rpmbuild/BUILD/asyncpg-0.25.0/docs/api/index.rst:211: WARNING: py:exc reference target not found: asyncpg.exceptions.InterfaceError
/home/tkloczko/rpmbuild/BUILD/asyncpg-0.25.0/docs/faq.rst:30: WARNING: py:func reference target not found: asyncpg.connection.connect
/home/tkloczko/rpmbuild/BUILD/asyncpg-0.25.0/docs/faq.rst:41: WARNING: py:meth reference target not found: asyncpg.connection.Connection.cursor
/home/tkloczko/rpmbuild/BUILD/asyncpg-0.25.0/docs/faq.rst:41: WARNING: py:meth reference target not found: asyncpg.prepared_stmt.PreparedStatement.cursor
/home/tkloczko/rpmbuild/BUILD/asyncpg-0.25.0/docs/faq.rst:71: WARNING: py:func reference target not found: asyncpg.connection.connect
/home/tkloczko/rpmbuild/BUILD/asyncpg-0.25.0/docs/faq.rst:71: WARNING: py:func reference target not found: asyncpg.pool.create_pool
/home/tkloczko/rpmbuild/BUILD/asyncpg-0.25.0/docs/faq.rst:71: WARNING: py:meth reference target not found: asyncpg.connection.Connection.prepare
done
build succeeded, 45 warnings.

The manual pages are in build/sphinx/man.
```

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
https://github.com/RDFLib/rdflib-sqlalchemy/issues/95
https://github.com/sissaschool/elementpath/commit/bf869d9e
https://github.com/jaraco/cssutils/issues/21
https://github.com/pywbem/pywbem/pull/2895

Guía de contribución

No hay ninguna guía de contribución indexada para este repositorio

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Línea de trabajo

Comienza reproduciendo el problema con el comando sphinx-build mostrado e inspecciona docs/usage.rst, docs/api/index.rst y docs/faq.rst junto con las advertencias de autodoc. Rastrea los destinos que faltan y los errores de importación; después, verifica que la compilación de la documentación finalice sin las advertencias de referencias indicadas.

Escrito por el modelo de indexación a partir del texto del issue.

Evaluación

Stack tecnológico
python
Área
documentation
Tipo de issue
Documentación
Dificultad
4/5
Tiempo estimado
3-5 días
Estado de actividad
Estancado
Claridad
Bastante claro
Aptitud para principiantes
35/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.