Hacktoberfest 2026：维护者为十月标记出来的 issue，仍然开放、适合新手。 浏览 Hacktoberfest issue

Add Sphinx json-schema extension

未关闭
#472 4 条评论 0 个 reaction 已指派 1 人 在 GitHub 查看

@a-zw 已经在做这个了。

开始于 2026年6月15日。

评估

这个 Issue 还没有评估数据。

描述

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

主要语言
Python
星标
11
派生
33
平均合并
22 小时 43 分钟
30 天内合并 PR
65

贡献指南

这个仓库没有索引到贡献指南

从这里开始

  1. 先读完整个 Issue，再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库，在一个分支上完成修改。
  4. 提交 Pull Request，并在描述里引用这个 Issue 编号。

eclipse-score/docs-as-code 的其他 Issue

查看 eclipse-score/docs-as-code 的全部 Issue

相似的 Issue

更多 Python Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。