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 is a PR adding the docs for the python library click. It only has 5 upvotes on the Trello board but I find myself using it offline quite regularly and annoyed at how little the doc is generally available.
The doc is in 2 main parts, “Documentation” (several pages / sections, which map well to types / entries) and “API” (single page, with sections containing functions/classes/etc.). I’ve made sure all these are searchable by making API sections types and API definitions entries. The remaining pages are listed as entries with as type the section under which they appear on the index page (currently only “Miscellaneous pages”).
License is open-sourced (BSD-3), but clause 3 specifies ”Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.” so I’ve added the following (similar to other docs) caveat to attribution to make sure we don’t claim endorsement/promotion:
public/icons/your_scraper_name/
directory:16.png
: a 16×16 pixel icon for the doc16@2x.png
: a 32×32 pixel icon for the docSOURCE
: A text file containing the URL to the page the image can be found on or the URL of the original image itself