Hacktoberfest 2026: những issue maintainer đã đánh dấu cho tháng Mười, đang mở và phù hợp người mới. Xem issue Hacktoberfest

Readthedocs not generating properly

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

Chưa có ai nhận issue này.

Đánh giá

Độ khó
2/5
Thời gian dự kiến
1-3 giờ
Mức phù hợp với người mới
58/100
Loại issue
Lỗi
Độ rõ ràng
Đặc tả rõ ràng
Mức độ hoạt động
Đình trệ
Công nghệ
docker
Lĩnh vực
build-system, documentation

Hướng nghiên cứu

Bắt đầu với docs/examples.rst ở dòng 10 và README.rst ở dòng 40, sau đó tái hiện quá trình build tài liệu của Read the Docs để kiểm tra các cảnh báo code-block. Kiểm tra để đảm bảo các directive ở cả hai vị trí đều đáp ứng cú pháp được ghi rõ trong tài liệu, và coi công việc là hoàn tất khi quá trình build hoàn thành mà không có các cảnh báo này.

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

Mô tả

bug documentation
Description

Problem with generating docs in readthedocs. Works locally and on github.
The problem seems to be the empty "..code-block::" directive.

/home/docs/checkouts/readthedocs.org/user_builds/eiffellib/checkouts/stable/docs/examples.rst:10: WARNING: Error in "code-block" directive:
1 argument(s) required, 0 supplied.

.. code-block::

   # From https://hub.docker.com/_/rabbitmq
   docker run -d --hostname my-rabbit --name some-rabbit -p 8080:15672 -p 5672:5672 rabbitmq:3-management
../README.rst:40: WARNING: Error in "code-block" directive:
1 argument(s) required, 0 supplied.

.. code-block::

   # From https://hub.docker.com/_/rabbitmq
   docker run -d --hostname my-rabbit --name some-rabbit -p 8080:15672 -p 5672:5672 rabbitmq:3-management
looking for now-outdated files... none found
Motivation

Readthedocs documentation should always work.

Exemplification
Benefits

Working documentation

Possible Drawbacks

none

Ngôn ngữ chính
Python
Star
8
Fork
12
Không có pull request nào được merge trong 30 ngày

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

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 eiffel-community/eiffel-pythonlib

Tất cả issue của eiffel-community/eiffel-pythonlib

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.