1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
|
# Contribute
If you'd like to develop or make contributions for sphinx-copybutton, fork
the repository here:
<https://github.com/ExecutableBookProject/sphinx-copybutton>
pull to your computer and install locally with `pip`:
```
pip install -e /path/to/sphinx_copybutton
```
**Pull requests** and **Issues** are absolutely welcome!
The package is tested for three things (see `.github/workflows/integration.yml`):
## code style
To adhere to this code style install the package with [pre-commit](https://pre-commit.com/):
```console
$ pip install .[code_style]
```
Then you can run:
```console
$ pre-commit run --all
```
Or setup pre-commit to run on code commits:
```console
$ pre-commit install
```
## JavaScript unit testing
Install the test dependencies with [npm](https://www.npmjs.com/):
```console
$ npm install ci
```
Then run the tests:
```console
$ npm test
```
:::{note}
NodeJS >= 12 is required
:::
## Documentation builds
Install the package:
```console
$ pip install .
```
Then run the docs build:
```console
$ cd doc
$ make html
```
|
