Sphinx config should not have pathlib instances
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 70/100
- Issue type
- Bug
- Clarity
- Mostly clear
- Activity status
- Active
- Tech stack
- python
- Domain
- documentation, tooling
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.
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.
- Dominant language
- Python
- Stars
- 11
- Forks
- 33
- Avg merge
- 22h 3m
- Merged PRs (30d)
- 62
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from eclipse-score/docs-as-code
-
good first issue
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
eclipse-score/docs-as-code#850 · 1 assignee ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
eclipse-score/docs-as-code#771 · 1 assignee ·
-
documentation
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
eclipse-score/docs-as-code#613 · 1 comment ·
-
update py_venv Open
Difficulty 2/5 1-3 hours Newbie friendliness 65/100
eclipse-score/docs-as-code#606 ·
-
Difficulty 5/5 Over a week Newbie friendliness 35/100
eclipse-score/docs-as-code#807 ·
All issues in eclipse-score/docs-as-code
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 74/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 84/100
gradio-app/gradio#13895 ·
-
build-error
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
spack/spack-packages#6713 ·
-
Use issue templates Open
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
ActivityWatch/activitywatch#1464 · 1 reaction ·
-
[Bug]: The ckg tool drops the return type of every decorated Python method in class search results Open
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
bytedance/trae-agent#483 ·