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

Sphinx config should not have pathlib instances

Open Beginner friendly
#288 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

During the implementation of https://github.com/eclipse-score/docs-as-code/pull/283 I observed that pathlib instances are created in the Sphinx configuration.
Affected path `needs.external_needs[0].json_path`.
Those can not be reflected in a declarative configuration such as TOML.

Paths should be stored as strings to be loadable from external TOML files.
It also makes sense for configuration pickling that Sphinx does for incremental builds.

Contributor guide

No contributing guide indexed for this repository

Research direction

Trace the Sphinx configuration handling for needs.external_needs[0].json_path, including the implementation discussed in pull request 283. Verify how the value is created and loaded, then confirm that configuration values remain strings and can be represented in external TOML and incremental-build pickling.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.