eclipse-score / eclipse-score/docs-as-code

Sphinx config should not store custom class instances

未关闭
#289 2 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看
bug waiting_for_author
主要语言
Python
星标
10
派生
32
平均合并
23 小时 52 分钟
30 天内合并 PR
52

描述

No custom classes should be stored to the configuration.
Same reasoning as in https://github.com/eclipse-score/docs-as-code/issues/288.

```
WARNING: Unsupported type at 'needs.render_context.draw_interface': draw_full_interface - filtering out [needs_config_writer.unsupported_type]
WARNING: Unsupported type at 'needs.render_context.draw_module': draw_full_module - filtering out [needs_config_writer.unsupported_type]
WARNING: Unsupported type at 'needs.render_context.draw_component': draw_full_component - filtering out [needs_config_writer.unsupported_type]
WARNING: Unsupported type at 'needs.render_context.draw_feature': draw_full_feature - filtering out [needs_config_writer.unsupported_type]
```

贡献指南

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

调研方向

首先阅读 issue 288,并跟踪警告中提到的 Sphinx 配置路径:needs.render_context.draw_interface、draw_module、draw_component 和 draw_feature。确定这些自定义类实例在哪里进入配置;当它们不再存储在那里且不支持类型警告消失时,即表示完成。

由索引模型根据 Issue 内容生成。

评估

技术栈
python
领域
documentation, tooling
Issue 类型
缺陷
难度
3/5
预计耗时
1-2 天
活跃度
停滞
描述清晰度
基本清楚
新手友好度
38/100

把新 issue 发到你的邮箱

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