Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add click documentation #2221

Merged
merged 6 commits into from
Jun 12, 2024
Merged

Add click documentation #2221

merged 6 commits into from
Jun 12, 2024

Conversation

Cimbali
Copy link
Contributor

@Cimbali Cimbali commented May 17, 2024

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:

We are not supported nor endorsed by Pallets.

  • Tested the scraper on a local copy of DevDocs
  • Ensured that the docs are styled similarly to other docs on DevDocs
  • Added these files to the public/icons/your_scraper_name/ directory:
    • 16.png: a 16×16 pixel icon for the doc
    • 16@2x.png: a 32×32 pixel icon for the doc
    • SOURCE: A text file containing the URL to the page the image can be found on or the URL of the original image itself

@Cimbali Cimbali requested a review from a team as a code owner May 17, 2024 23:34
Cimbali and others added 3 commits May 23, 2024 15:51
Get all (not only top-level) definitions, add () suffix on functions
(and methods of all kinds).
@simon04
Copy link
Contributor

simon04 commented Jun 12, 2024

The old versions fail to build, thus I'm removing them for now:

ERROR:                                                                                                                                                                                              
  https://click.palletsprojects.com/en/6.x/index.html
  Docs::ContainerFilter::ContainerNotFound: element '.body > section' could not be found in the document, url=https://click.palletsprojects.com/en/6.x/index.html

Copy link
Contributor

@simon04 simon04 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great, thank you!

@simon04 simon04 merged commit 6512f29 into freeCodeCamp:main Jun 12, 2024
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants