2.6.2: sphinx warnings `reference target not found`

Abierto
  • ¿Algo no está bien?
#172 2 comentarios 0 reacciones 0 asignados Ver en GitHub

Los mantenedores suelen responder en 1 día

@amritamishra01 ya está trabajando en esto.

Desde el 23/11/2025.

  • #223 de @amritamishra01 — abierto

Evaluación

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

Línea de trabajo

Ejecute el comando reportado sphinx-build -n -T -b man doc build/sphinx/man e inspeccione las advertencias en doc/run_benchmark.rst, doc/system.rst, doc/api.rst y doc/changelog.rst. Revise las referencias faltantes enumeradas y la advertencia sobre el título; después, vuelva a generar las páginas man para verificar que las advertencias reportadas se hayan resuelto.

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 doc build/sphinx/man
Running Sphinx v7.1.2
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
writing output...
building [man]: all manpages
updating environment: [new config] 11 added, 0 changed, 0 removed
reading sources... [100%] user_guide
/home/tkloczko/rpmbuild/BUILD/pyperf-2.6.2/doc/run_benchmark.rst:195: WARNING: Title underline too short.

Specializer statistics (``pystats``)
==================================
/home/tkloczko/rpmbuild/BUILD/pyperf-2.6.2/doc/run_benchmark.rst:195: WARNING: Title underline too short.

Specializer statistics (``pystats``)
==================================
looking for now-outdated files... none found
pickling environment... done
checking consistency... done
writing... pyperf.1 { user_guide run_benchmark analyze cli runner system developer_guide examples api changelog } /home/tkloczko/rpmbuild/BUILD/pyperf-2.6.2/doc/run_benchmark.rst:109: WARNING: py:attr reference target not found: Runner.inner_loops
/home/tkloczko/rpmbuild/BUILD/pyperf-2.6.2/doc/system.rst:24: WARNING: py:func reference target not found: os.sched_setaffinity
/home/tkloczko/rpmbuild/BUILD/pyperf-2.6.2/doc/api.rst:196: WARNING: py:class reference target not found: (datetime.datetime, datetime.datetime) or None
/home/tkloczko/rpmbuild/BUILD/pyperf-2.6.2/doc/api.rst:225: WARNING: py:class reference target not found: int or float
/home/tkloczko/rpmbuild/BUILD/pyperf-2.6.2/doc/api.rst:247: WARNING: py:class reference target not found: int or float
/home/tkloczko/rpmbuild/BUILD/pyperf-2.6.2/doc/api.rst:256: WARNING: py:class reference target not found: int or float
/home/tkloczko/rpmbuild/BUILD/pyperf-2.6.2/doc/api.rst:265: WARNING: py:class reference target not found: int or float
/home/tkloczko/rpmbuild/BUILD/pyperf-2.6.2/doc/api.rst:284: WARNING: py:data reference target not found: sys.stdin
/home/tkloczko/rpmbuild/BUILD/pyperf-2.6.2/doc/api.rst:377: WARNING: py:class reference target not found: Benchmark or BenchmarkSuite
/home/tkloczko/rpmbuild/BUILD/pyperf-2.6.2/doc/api.rst:417: WARNING: py:class reference target not found: (datetime.datetime, datetime.datetime) or None
/home/tkloczko/rpmbuild/BUILD/pyperf-2.6.2/doc/api.rst:456: WARNING: py:data reference target not found: sys.stdin
/home/tkloczko/rpmbuild/BUILD/pyperf-2.6.2/doc/api.rst:599: WARNING: py:func reference target not found: time.perf_counter
/home/tkloczko/rpmbuild/BUILD/pyperf-2.6.2/doc/api.rst:629: WARNING: py:func reference target not found: time.perf_counter
/home/tkloczko/rpmbuild/BUILD/pyperf-2.6.2/doc/api.rst:658: WARNING: py:class reference target not found: argparse.ArgumentParser
/home/tkloczko/rpmbuild/BUILD/pyperf-2.6.2/doc/changelog.rst:454: WARNING: py:func reference target not found: Benchmark.bench_func
/home/tkloczko/rpmbuild/BUILD/pyperf-2.6.2/doc/changelog.rst:454: WARNING: py:func reference target not found: Benchmark.bench_sample_func
/home/tkloczko/rpmbuild/BUILD/pyperf-2.6.2/doc/changelog.rst:560: WARNING: py:func reference target not found: perf.python_implementation
/home/tkloczko/rpmbuild/BUILD/pyperf-2.6.2/doc/changelog.rst:560: WARNING: py:func reference target not found: perf.python_has_jit
/home/tkloczko/rpmbuild/BUILD/pyperf-2.6.2/doc/changelog.rst:621: WARNING: py:class reference target not found: Metadata
/home/tkloczko/rpmbuild/BUILD/pyperf-2.6.2/doc/changelog.rst:652: WARNING: py:class reference target not found: perf.BenchmarkSuite
/home/tkloczko/rpmbuild/BUILD/pyperf-2.6.2/doc/changelog.rst:671: WARNING: py:meth reference target not found: perf.Benchmark.median
/home/tkloczko/rpmbuild/BUILD/pyperf-2.6.2/doc/changelog.rst:672: WARNING: py:attr reference target not found: perf.Benchmark.metadata
/home/tkloczko/rpmbuild/BUILD/pyperf-2.6.2/doc/changelog.rst:720: WARNING: py:meth reference target not found: TextRunner.bench_sample_func
/home/tkloczko/rpmbuild/BUILD/pyperf-2.6.2/doc/changelog.rst:724: WARNING: py:func reference target not found: perf.is_significant
/home/tkloczko/rpmbuild/BUILD/pyperf-2.6.2/doc/changelog.rst:725: WARNING: py:class reference target not found: perf.Benchmark
/home/tkloczko/rpmbuild/BUILD/pyperf-2.6.2/doc/changelog.rst:726: WARNING: py:class reference target not found: perf.Benchmark
/home/tkloczko/rpmbuild/BUILD/pyperf-2.6.2/doc/changelog.rst:727: WARNING: py:attr reference target not found: TextRunner.inner_loops
/home/tkloczko/rpmbuild/BUILD/pyperf-2.6.2/doc/changelog.rst:727: WARNING: py:class reference target not found: TextRunner
/home/tkloczko/rpmbuild/BUILD/pyperf-2.6.2/doc/changelog.rst:736: WARNING: py:class reference target not found: TextRunner
done
build succeeded, 32 warnings.

You can peak on fixes that kind of issues in other projects
https://github.com/RDFLib/rdflib-sqlalchemy/issues/95
https://github.com/RDFLib/rdflib/pull/2036
https://github.com/click-contrib/sphinx-click/commit/abc31069
https://github.com/frostming/unearth/issues/14
https://github.com/jaraco/cssutils/issues/21
https://github.com/latchset/jwcrypto/pull/289
https://github.com/latchset/jwcrypto/pull/289
https://github.com/pypa/distlib/commit/98b9b89f
https://github.com/pywbem/pywbem/pull/2895
https://github.com/sissaschool/elementpath/commit/bf869d9e
https://github.com/sissaschool/xmlschema/commit/42ea98f2
https://github.com/sqlalchemy/sqlalchemy/commit/5e88e6e8

Lenguaje dominante
Python
Estrellas
967
Forks
112
Merge medio
5 d 8 h
PR fusionados (30 d)
9

Preparar el entorno

Este proyecto no incluye contenedor de desarrollo, Dockerfile ni guía de contribución, así que la configuración corre por tu cuenta: empieza por su README y consulta nuestra guía para la primera contribución para los pasos generales.

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 psf/pyperf

Todos los issues de psf/pyperf

Issues similares

Más issues de Python

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.