prompt-toolkit / prompt-toolkit/python-prompt-toolkit
Suggestion to enable the "Preview Documentation from Pull Requests" feature at RTD
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 10.6k
- Forks
- 815
- PR merge metrics
- No merged PRs in 30d
Description
Dear Jonathan,
the "Preview Documentation from Pull Requests" feature at RTD ^1 is very sweet to detect if your documentation builds correctly on each pull request, and gives an excellent visual feedback about the outcome.
Also, the Details link goes directly to the build output on RTD while the build is running, and to a pre-rendered page when the build succeeded.
If you like what you are seeing, you may want to enable the corresponding feature in the RTD user interface. Effectively, it is just checking a tick box.
With kind regards,
Andreas.
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
Read the linked Read the Docs pull-request preview documentation first. Then verify whether this repository’s documentation hosting is configured for that feature; done means the setting is enabled and pull-request builds expose the preview and Details link.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 30/100