From b8d9ae4413ac250a2ba5ef7a38a2fa706d7dd9a1 Mon Sep 17 00:00:00 2001 From: championshuttler Date: Wed, 3 Jun 2020 19:22:03 +0000 Subject: [PATCH] Bug 1643074 - Add a copy button to firefox docs to copy commands. r=firefox-source-docs-reviewers,ahal Differential Revision: https://phabricator.services.mozilla.com/D78110 --- docs/conf.py | 1 + tools/moztreedocs/Pipfile | 1 + tools/moztreedocs/Pipfile.lock | 29 ++++++++++++++++++----------- 3 files changed, 20 insertions(+), 11 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index d73212a8b023..eeeb1dc2b861 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -44,6 +44,7 @@ extensions = [ 'sphinx_js', 'sphinxcontrib.mermaid', 'recommonmark', + 'sphinx_copybutton', ] # JSDoc must run successfully for dirs specified, so running diff --git a/tools/moztreedocs/Pipfile b/tools/moztreedocs/Pipfile index ec459bfdcd44..f34abddc44ee 100644 --- a/tools/moztreedocs/Pipfile +++ b/tools/moztreedocs/Pipfile @@ -17,6 +17,7 @@ sphinx-rtd-theme = "~=0.4.3" sphinxcontrib-mermaid = "~=0.4.0" sphinx = "~=2.2.2" tornado = "~=6.0.3" +sphinx-copybutton = "~=0.2.11" [requires] python_version = "3" diff --git a/tools/moztreedocs/Pipfile.lock b/tools/moztreedocs/Pipfile.lock index b7fb61ce52e3..dba092e18d61 100644 --- a/tools/moztreedocs/Pipfile.lock +++ b/tools/moztreedocs/Pipfile.lock @@ -1,7 +1,7 @@ { "_meta": { "hash": { - "sha256": "d7cdaa0c3cbe76bd75e3f3a799cce181cf737d15715e27c1cf7472aeab083661" + "sha256": "739cdb3dbbd50135d1c56f15c125cbe1d4731ff0edb16b75a490e5ddbf076fab" }, "pipfile-spec": 6, "requires": { @@ -92,10 +92,10 @@ }, "fluent.syntax": { "hashes": [ - "sha256:ac3db2f77d62b032fdf1f17ef5c390b7801a9e9fb58d41eca3825c0d47b88d79", - "sha256:e26be470aeebe4badd84f7bb0b648414e0f2ef95d26e5336d634af99e402ea61" + "sha256:202890bce8be17afd225374a29a9dae7e09edab54aca0dcb47495ba9a5ea72e9", + "sha256:e2df446e102824472768c04d24348247f7d8b08813cd29f3c39815796cb8821e" ], - "version": "==0.17.0" + "version": "==0.18.0" }, "idna": { "hashes": [ @@ -173,10 +173,10 @@ }, "packaging": { "hashes": [ - "sha256:3c292b474fda1671ec57d46d739d072bfd495a4f51ad01a055121d81e952b7a3", - "sha256:82f77b9bee21c1bafbf35a84905d604d5d1223801d639cf3ed140bd651c08752" + "sha256:4357f74f47b9c12db93624a82154e9b120fa8293699949152b22065d556079f8", + "sha256:998416ba6962ae7fbd6596850b80e17859a5753ba17c32284f67bfff33784181" ], - "version": "==20.3" + "version": "==20.4" }, "parsimonious": { "hashes": [ @@ -286,10 +286,10 @@ }, "six": { "hashes": [ - "sha256:236bdbdce46e6e6a3d61a337c0f8b763ca1e8717c03b369e87a7ec7ce1319c0a", - "sha256:8f3cd2e254d8f793e7f3d6d9df77b92252b52637291d0f0da013c76ea2724b6c" + "sha256:30639c035cdb23534cd4aa2dd52c3bf48f06e5f4a941509c8bafd8ce11080259", + "sha256:8b74bedcbbbaca38ff6d7491d76f2b06b3592611af620f8426e82dddb04a5ced" ], - "version": "==1.14.0" + "version": "==1.15.0" }, "snowballstemmer": { "hashes": [ @@ -306,6 +306,14 @@ "index": "pypi", "version": "==2.2.2" }, + "sphinx-copybutton": { + "hashes": [ + "sha256:7eff55f0d1f8aee42f9538b5659efe326d58fea04c11c986886bbdc0a233232d", + "sha256:cf3bb6dc4b82217fe1a765d733aa478949ae8574670aa2c5e7c94de81326ad50" + ], + "index": "pypi", + "version": "==0.2.11" + }, "sphinx-js": { "hashes": [ "sha256:8c6775b8be82b6edbac12e1f8b590e6f5a24585549bd18043ec47d1051560de2", @@ -392,7 +400,6 @@ "sha256:3018294ebefce6572a474f0604c2021e33b3fd8006ecd11d62107a5d2a963527", "sha256:88206b0eb87e6d677d424843ac5209e3fb9d0190d0ee169599165ec25e9d9115" ], - "markers": "python_version >= '3.4'", "version": "==1.25.9" } },