sphinx-contrib / sphinx-contrib/openapi
An unused page "HTTP Routing Table" when generating pdf by rst2pdf
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 126
- Forks
- 88
- PR merge metrics
- No merged PRs in 30d
Description
Currently, I'm using this extension to help me generate a pdf document, and I found when using this with rst2pdf.pdfbuilder
, it would generate an extra page like
And this page is generated by httpdomain extension if we didn't set up noindex option under the directives.
Is there any side effect if we do this change? (function _httpresource under openapi20.py and openapi30.py)
Or any other options to avoid this routing table page?
Thanks
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 inspecting the _httpresource functions in openapi20.py and openapi30.py, then reproduce PDF generation with rst2pdf.pdfbuilder to determine how the HTTP Routing Table page is added. Done means identifying a supported way to avoid the unused page without unwanted effects on the generated documentation.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100