Hacktoberfest 2026: los issues que los mantenedores marcaron para octubre, abiertos y aptos para principiantes. Explorar issues de Hacktoberfest

0.10.2: sphinx warnings `reference target not found`

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

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
4/5
Tiempo estimado
3-5 días
Aptitud para principiantes
38/100
Tipo de issue
Error
Claridad
Bastante claro
Estado de actividad
Estancado
Stack tecnológico
python

Línea de trabajo

Reproduce el informe con sphinx-build -n -T -b man docs build/sphinx/man y, después, inspecciona los docstrings referenciados en tomlkit/init.py, tomlkit/items.py y tomlkit/toml_document.py, junto con la configuración de la documentación. Se considera terminado cuando la compilación ya no emita las advertencias indicadas de missing-reference, duplicate-description y _static ausente.

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

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:

+ /usr/bin/sphinx-build -n -T -b man docs build/sphinx/man
Running Sphinx v4.5.0
making output directory... done
WARNING: html_static_path entry '_static' does not exist
building [mo]: targets for 0 po files that are out of date
building [man]: all manpages
updating environment: [new config] 3 added, 0 changed, 0 removed
reading sources... [100%] quickstart
/home/tkloczko/rpmbuild/BUILD/tomlkit-0.10.2/tomlkit/items.py:docstring of tomlkit.items:1: WARNING: duplicate object description of tomlkit.items, other instance in api, use :noindex: for one of them
/home/tkloczko/rpmbuild/BUILD/tomlkit-0.10.2/tomlkit/__init__.py:docstring of tomlkit.api.string:7: ERROR: Unknown target name: "https://toml.io/en/v1.0.0#string".
looking for now-outdated files... none found
pickling environment... done
checking consistency... done
writing... tomlkit.1 { quickstart api } /home/tkloczko/rpmbuild/BUILD/tomlkit-0.10.2/tomlkit/__init__.py:docstring of tomlkit.api.dump:: WARNING: py:class reference target not found: collections.abc.Mapping
/home/tkloczko/rpmbuild/BUILD/tomlkit-0.10.2/tomlkit/__init__.py:docstring of tomlkit.api.dump:: WARNING: py:obj reference target not found: typing.IO
/home/tkloczko/rpmbuild/BUILD/tomlkit-0.10.2/tomlkit/__init__.py:docstring of tomlkit.api.dumps:: WARNING: py:class reference target not found: collections.abc.Mapping
/home/tkloczko/rpmbuild/BUILD/tomlkit-0.10.2/tomlkit/__init__.py:docstring of tomlkit.api.load:: WARNING: py:obj reference target not found: typing.IO
/home/tkloczko/rpmbuild/BUILD/tomlkit-0.10.2/tomlkit/toml_document.py:docstring of tomlkit.toml_document.TOMLDocument:1: WARNING: py:class reference target not found: tomlkit.container.Container
/home/tkloczko/rpmbuild/BUILD/tomlkit-0.10.2/tomlkit/toml_document.py:docstring of tomlkit.container.Container.add:: WARNING: py:class reference target not found: tomlkit.container.Container
/home/tkloczko/rpmbuild/BUILD/tomlkit-0.10.2/tomlkit/toml_document.py:docstring of tomlkit.container.Container.append:: WARNING: py:class reference target not found: tomlkit.container.Container
/home/tkloczko/rpmbuild/BUILD/tomlkit-0.10.2/tomlkit/toml_document.py:docstring of collections.abc.MutableMapping.clear:: WARNING: py:class reference target not found: None.  Remove all items from D.
/home/tkloczko/rpmbuild/BUILD/tomlkit-0.10.2/tomlkit/toml_document.py:docstring of tomlkit.container.Container.copy:: WARNING: py:class reference target not found: a shallow copy of D
/home/tkloczko/rpmbuild/BUILD/tomlkit-0.10.2/tomlkit/toml_document.py:docstring of collections.abc.Mapping.get:: WARNING: py:class reference target not found: D[k] if k in D, else d.  d defaults to None.
/home/tkloczko/rpmbuild/BUILD/tomlkit-0.10.2/tomlkit/toml_document.py:docstring of collections.abc.Mapping.items:: WARNING: py:class reference target not found: a set-like object providing a view on D's items
/home/tkloczko/rpmbuild/BUILD/tomlkit-0.10.2/tomlkit/toml_document.py:docstring of collections.abc.Mapping.keys:: WARNING: py:class reference target not found: a set-like object providing a view on D's keys
/home/tkloczko/rpmbuild/BUILD/tomlkit-0.10.2/tomlkit/toml_document.py:docstring of collections.abc.MutableMapping.pop:: WARNING: py:class reference target not found: v, remove specified key and return the corresponding value.
/home/tkloczko/rpmbuild/BUILD/tomlkit-0.10.2/tomlkit/toml_document.py:docstring of collections.abc.MutableMapping.popitem:: WARNING: py:class reference target not found: (k, v), remove and return some (key, value) pair
/home/tkloczko/rpmbuild/BUILD/tomlkit-0.10.2/tomlkit/toml_document.py:docstring of tomlkit.container.Container.remove:: WARNING: py:class reference target not found: tomlkit.container.Container
/home/tkloczko/rpmbuild/BUILD/tomlkit-0.10.2/tomlkit/toml_document.py:docstring of tomlkit.container.Container.setdefault:: WARNING: py:class reference target not found: D.get(k,d), also set D[k]=d if k not in D
/home/tkloczko/rpmbuild/BUILD/tomlkit-0.10.2/tomlkit/toml_document.py:docstring of collections.abc.MutableMapping.update:: WARNING: py:class reference target not found: None.  Update D from mapping/iterable E and F.
/home/tkloczko/rpmbuild/BUILD/tomlkit-0.10.2/tomlkit/toml_document.py:docstring of collections.abc.Mapping.values:: WARNING: py:class reference target not found: an object providing a view on D's values
/home/tkloczko/rpmbuild/BUILD/tomlkit-0.10.2/tomlkit/items.py:docstring of tomlkit.items.AoT:1: WARNING: py:class reference target not found: tomlkit.items._CustomList
/home/tkloczko/rpmbuild/BUILD/tomlkit-0.10.2/tomlkit/items.py:docstring of tomlkit.items.Array:1: WARNING: py:class reference target not found: tomlkit.items._CustomList
/home/tkloczko/rpmbuild/BUILD/tomlkit-0.10.2/tomlkit/items.py:docstring of tomlkit.items.BoolType:1: WARNING: py:class reference target not found: enum.Enum
/home/tkloczko/rpmbuild/BUILD/tomlkit-0.10.2/tomlkit/items.py:docstring of tomlkit.items.Date:1: WARNING: py:class reference target not found: datetime.date
/home/tkloczko/rpmbuild/BUILD/tomlkit-0.10.2/tomlkit/items.py:docstring of tomlkit.items.Date.replace:: WARNING: py:class reference target not found: datetime.date
/home/tkloczko/rpmbuild/BUILD/tomlkit-0.10.2/tomlkit/items.py:docstring of tomlkit.items.DateTime:: WARNING: py:class reference target not found: datetime.tzinfo
/home/tkloczko/rpmbuild/BUILD/tomlkit-0.10.2/tomlkit/items.py:docstring of tomlkit.items.DateTime:1: WARNING: py:class reference target not found: datetime.datetime
/home/tkloczko/rpmbuild/BUILD/tomlkit-0.10.2/tomlkit/items.py:docstring of tomlkit.items.DateTime.astimezone:: WARNING: py:class reference target not found: datetime.tzinfo
/home/tkloczko/rpmbuild/BUILD/tomlkit-0.10.2/tomlkit/items.py:docstring of tomlkit.items.DateTime.astimezone:: WARNING: py:class reference target not found: datetime.datetime
/home/tkloczko/rpmbuild/BUILD/tomlkit-0.10.2/tomlkit/items.py:docstring of tomlkit.items.DateTime.replace:: WARNING: py:class reference target not found: datetime.datetime
/home/tkloczko/rpmbuild/BUILD/tomlkit-0.10.2/tomlkit/items.py:docstring of tomlkit.items.InlineTable:: WARNING: py:class reference target not found: container.Container
/home/tkloczko/rpmbuild/BUILD/tomlkit-0.10.2/tomlkit/items.py:docstring of tomlkit.items.InlineTable:1: WARNING: py:class reference target not found: tomlkit.items.AbstractTable
/home/tkloczko/rpmbuild/BUILD/tomlkit-0.10.2/tomlkit/items.py:docstring of tomlkit.items.Key:1: WARNING: py:class reference target not found: abc.ABC
/home/tkloczko/rpmbuild/BUILD/tomlkit-0.10.2/tomlkit/items.py:docstring of tomlkit.items.KeyType:1: WARNING: py:class reference target not found: enum.Enum
/home/tkloczko/rpmbuild/BUILD/tomlkit-0.10.2/tomlkit/items.py:docstring of tomlkit.items.StringType:1: WARNING: py:class reference target not found: enum.Enum
/home/tkloczko/rpmbuild/BUILD/tomlkit-0.10.2/tomlkit/items.py:docstring of tomlkit.items.Table:: WARNING: py:class reference target not found: container.Container
/home/tkloczko/rpmbuild/BUILD/tomlkit-0.10.2/tomlkit/items.py:docstring of tomlkit.items.Table:1: WARNING: py:class reference target not found: tomlkit.items.AbstractTable
/home/tkloczko/rpmbuild/BUILD/tomlkit-0.10.2/tomlkit/items.py:docstring of tomlkit.items.Time:: WARNING: py:class reference target not found: datetime.tzinfo
/home/tkloczko/rpmbuild/BUILD/tomlkit-0.10.2/tomlkit/items.py:docstring of tomlkit.items.Time:1: WARNING: py:class reference target not found: datetime.time
/home/tkloczko/rpmbuild/BUILD/tomlkit-0.10.2/tomlkit/items.py:docstring of tomlkit.items.Time.replace:: WARNING: py:class reference target not found: datetime.time
done
build succeeded, 41 warnings.
Lenguaje dominante
Python
Estrellas
850
Forks
163
Merge medio
13 min
PR fusionados (30 d)
2

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.

Más de python-poetry/tomlkit

Todos los issues de python-poetry/tomlkit

Issues similares

Más issues de Python

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.