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

Sphinx config should not store custom class instances

Open
#289 2 comments 0 reactions 0 assignees View on GitHub
bug waiting_for_author
Dominant language
Python
Stars
10
Forks
32
Avg merge
23h 52m
Merged PRs (30d)
52

Description

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]
```

Contributor guide

No contributing guide indexed for this repository

Research direction

Start by reading issue 288 and tracing the Sphinx configuration paths named in the warnings: needs.render_context.draw_interface, draw_module, draw_component, and draw_feature. Identify where these custom class instances enter the configuration; done means they are no longer stored there and the unsupported-type warnings disappear.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation, tooling
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.