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
|
# Instructions for creating a new release
Spinx-Copybutton is [hosted on the pypi repository](https://pypi.org/project/sphinx-thebe/).
To create a new release of sphinx-thebe, you need to do these things:
## Before you start
1. Ensure that you have push access to the [sphinx-thebe pypi repository](https://pypi.org/project/sphinx-thebe/)
2. Install [the twine package](https://twine.readthedocs.io/en/latest/). This is a package that helps you
bundle and push new Python package distributions to pip.
## To create the release
To create a new release, [open an issue](https://github.com/executablebooks/sphinx-thebe/issues/new) to keep
track of the to-do list for the release. Copy/paste the following markdown into the issue
and check off the boxes as you complete items:
```
- [ ] Ensure that the [sphinx-thebe version number](https://github.com/executablebooks/sphinx-thebe/blob/master/jupyter_book/__init__.py)
is correct, and remove the `dev0` part of the version number.
Make a PR with the new number and merge into master.
- [ ] Create a new distribution for sphinx-thebe by
[following the twine release instructions](https://twine.readthedocs.io/en/latest/#using-twine)
- [ ] Confirm that the new version of sphinx-thebe [is posted to pypi](https://pypi.org/project/sphinx-thebe/)
- [ ] Bump the [sphinx-thebe version number](https://github.com/executablebooks/sphinx-thebe/blob/master/jupyter_book/__init__.py) to
the next minor (or major) release and append `dev0` to the end.
- [ ] Celebrate! You've just released a new version of sphinx-thebe!
```
|
