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

Add Sphinx json-schema extension

Đang mở
#472 4 bình luận 0 reaction 1 người được giao Xem trên GitHub

@a-zw đang làm issue này rồi.

Từ ngày 15/6/2026.

Đánh giá

Issue này chưa được đánh giá.

Mô tả

Feature Request / Modification Description

There has been a lot of repos that include a json-schema file that has some docs on what each field is
e.g :
communication
lifecycle
log

In the user facing docs it's nice to also explain these fields and so there is duplication of information (lifecycle config docs)

There exists an extension that given the json schema generates a table https://sphinx-jsonschema.readthedocs.io/en/latest/directive.html#an-example

Example with lifecycle docs:
Image

Expected Changes ot work products
  • Requirements
  • Architecture
  • Safety Analysis
  • Security Analysis
  • Detailed Design
  • Implementation and Testing
  • all
Impact analysis

Docs are not required to use this extension so no impact

Safety or Security relevance
  • none
  • Safety relevant
  • Security relevant
Expected required ASIL classification

QM

Expected Implementation Version (Release)

1.0

Ngôn ngữ chính
Python
Star
11
Fork
33
Merge trung bình
22 giờ 43 phút
Pull request đã merge (30 ngày)
65

Hướng dẫn đóng góp

Chưa lập chỉ mục được hướng dẫn đóng góp cho kho mã nguồn này

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 eclipse-score/docs-as-code

Tất cả issue của eclipse-score/docs-as-code

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.