pallets / pallets/click

Add Screenshot workflow

Open
#3,081 18 comments 0 reactions 0 assignees View on GitHub

A pull request for this has already been merged.

  • #3472 by @saxenanurag — merged
docs
Dominant language
Python
Stars
17.7k
Forks
2.3k
Avg merge
1d 30m
Merged PRs (30d)
18

Description

In a few places in the docs, it would be really nice to be able to run some code take a screen shot, and draw boxes around different parts. For example setup an example click app with multiple sub commands, options, epilog help, and arguments and then draw boxes and label the various blocks. Requirements:

  • run locally for doc generation (actually locally not calling out to api)
  • run in ci job (not calling out to external service)
  • No added dependencies that are not pip installable
  • have the screen shots not be blurry (common problem)
  • draw boxes around various sections.

Conduct some research and propose some options. A maintainer will pick from the options. and you can implement it. Here is an example of what I was thinking is in the comments below.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by researching locally runnable, pip-installable options for generating sharp screenshots and annotating CLI documentation examples, including execution in CI without external services. Use the stated requirements to compare the options and propose them to a maintainer; the research is complete when one option is selected for implementation.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
cli, documentation
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.