sphinx-contrib / sphinx-contrib/openapi
Restructure docs to reflect recents changes in renderers
Open
Nobody has claimed this yet.
docs
- Dominant language
- Python
- Stars
- 126
- Forks
- 88
- PR merge metrics
- No merged PRs in 30d
Description
The extension now supports multi-renderers architecture, which means we can have more than one renderer to render the OpenAPI spec. Each renderer may have its own set of configuration options, and so we need to update the docs to reflect these changes.
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
Start by reviewing the repository's existing documentation for renderer configuration and the extension architecture. Update the documentation to explain multiple renderers and each renderer's configuration options, then verify that the documented structure matches the current implementation.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 30/100