scality / metalk8s

An opinionated Kubernetes distribution with a focus on long-term on-prem deployments
Apache License 2.0
360 stars 45 forks source link

Expose an easy way to copy-paste commands from documentation #3161

Open gdemonet opened 3 years ago

gdemonet commented 3 years ago

Component: docs

Why this is needed:

Code-blocks in documentation are not always easy to handle for users, as different prompts may be confusing when deciding which parts of a documented command should be copy-pasted. The Sphinx extension sphinx-copybutton exists to help with this situation.

What should be done:

Test plan:

gdemonet commented 3 years ago

Since sphinx-copybutton has limitations, we will rather use a homemade extension as part of the Scality-built Sphinx tooling (see scality/sphinx-tools#32)