docs/README: Add readthedocs-howto #5498
Closed
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This adds a short paragraph on how to hook readthedocs.org up. Not that it is rocket science, the main goal is to make people aware of the option (hadn't occurred to me).
|
I don't personally see the benefit of this. Isn't it far easier to just build the docs locally as you make changes? |
Overall it's a small paragraph that doesn't clutter the page much and doesn't need maintenance, but if you don't like it just close the PR... |
|
Ok, thanks for the reasoning, sounds good to help people contribute to the docs. Rebased and merged in bc5c993 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This adds a short paragraph on how to hook readthedocs.org up.
Not that it is rocket science, the main goal is to make people aware of the option
(hadn't occurred to me).