Skip to content

Commit

Permalink
Add a copy button to all code snippets in docs (#1030)
Browse files Browse the repository at this point in the history
There is a sphinx extension (sphinx_copybutton) that enables a
copy button for every code-block included in our docs. This is a
nice and easy usability change.

Signed-off-by: Eric Brown <eric_wade_brown@yahoo.com>
  • Loading branch information
ericwb committed Jun 2, 2023
1 parent 4182f6b commit b9ae420
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 0 deletions.
1 change: 1 addition & 0 deletions doc/requirements.txt
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,4 @@
# process, which may cause wedges in the gate later.
sphinx>=4.0.0 # BSD
sphinx-rtd-theme>=0.3.0
sphinx-copybutton
1 change: 1 addition & 0 deletions doc/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@
"sphinx.ext.doctest",
"sphinx.ext.coverage",
"sphinx.ext.viewcode",
"sphinx_copybutton",
]

# autodoc generation is a bit aggressive and a nuisance when doing heavy
Expand Down

0 comments on commit b9ae420

Please sign in to comment.