sphinx-contrib / sphinx-contrib/openapi
Exclude option fails when providing more than one path to exclude
Open
Nobody has claimed this yet.
bug
- Dominant language
- Python
- Stars
- 126
- Forks
- 88
- PR merge metrics
- No merged PRs in 30d
Description
If more than one path is specified under "exclude" option, the paths rendered will not be as expected. For example, if /persons and /evidence is specified, both will be rendered.
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.
Research direction
Reproduce the issue in a Sphinx project using the OpenAPI extension with /persons and /evidence under the exclude option. Trace how multiple exclude paths are processed and verify the rendered output omits both paths while retaining other content.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- openapi, python
- Domain
- documentation
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100