2.6.2: sphinx warnings `reference target not found`

Đang mở
  • Có gì không ổn?
#172 2 bình luận 0 reaction 0 người được giao Xem trên GitHub

Maintainer thường phản hồi trong vòng 1 ngày

@amritamishra01 đang làm issue này rồi.

Từ ngày 23/11/2025.

  • #223 của @amritamishra01 — đang mở

Đánh giá

Độ khó
3/5
Thời gian dự kiến
1-2 ngày
Mức phù hợp với người mới
42/100
Loại issue
Tài liệu
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Đình trệ
Công nghệ
python
Lĩnh vực
documentation

Hướng nghiên cứu

Chạy lệnh sphinx-build -n -T -b man doc build/sphinx/man đã được báo cáo và kiểm tra các cảnh báo trong doc/run_benchmark.rst, doc/system.rst, doc/api.rst và doc/changelog.rst. Xem lại các tham chiếu bị thiếu được liệt kê và cảnh báo về tiêu đề, sau đó xây dựng lại các trang man để xác minh rằng các cảnh báo đã báo cáo đã được giải quyết.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

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

Ngôn ngữ chính
Python
Star
967
Fork
112
Merge trung bình
5 ngày 8 giờ
Pull request đã merge (30 ngày)
9

Chuẩn bị môi trường

Dự án này không cung cấp dev container, Dockerfile hay hướng dẫn đóng góp, nên bạn cần tự thiết lập môi trường: hãy bắt đầu từ README và xem hướng dẫn đóng góp lần đầu của chúng tôi để biết các bước chung.

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của psf/pyperf

Tất cả issue của psf/pyperf

Issue tương tự

Thêm issue về Python

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.