Skip to content

Commit 2bf5d6c

Browse files
authored
docs: update release instruction (#260)
1 parent cc53f60 commit 2bf5d6c

File tree

12 files changed

+529
-586
lines changed

12 files changed

+529
-586
lines changed

.pre-commit-config.yaml

Lines changed: 0 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -36,17 +36,6 @@ repos:
3636
- id: prettier
3737
types_or: [yaml, html, json]
3838

39-
- repo: https://github.com/adamchainz/blacken-docs
40-
rev: "1.16.0"
41-
hooks:
42-
- id: blacken-docs
43-
additional_dependencies: [black==23.7.0]
44-
exclude: |
45-
(?x)^(
46-
doc/source/index.rst|
47-
tests/test_execute.py
48-
)$(|)
49-
5039
- repo: https://github.com/codespell-project/codespell
5140
rev: "v2.2.6"
5241
hooks:
@@ -68,9 +57,3 @@ repos:
6857
args: ["--fix", "--show-fixes"]
6958
- id: ruff-format
7059
types_or: [python, jupyter]
71-
72-
- repo: https://github.com/scientific-python/cookie
73-
rev: "2023.10.27"
74-
hooks:
75-
- id: sp-repo-review
76-
additional_dependencies: ["repo-review[cli]"]

.readthedocs.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
1+
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
12
version: 2
23
build:
34
os: ubuntu-22.04
45
tools:
5-
python: "3.8"
6+
python: "3.10"
67
sphinx:
7-
configuration: doc/source/conf.py
8+
configuration: docs/conf.py
89
python:
910
install:
10-
# install itself with pip install .
1111
- method: pip
1212
path: .
1313
extra_requirements:

RELEASE.md

Lines changed: 3 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,10 @@ To cut a new Jupyter Sphinx release, follow these steps:
88
- Ensure that all tests are passing on master.
99

1010
- In [`_version.py`](https://github.com/jupyter/jupyter-sphinx/blob/main/jupyter_sphinx/_version.py),
11-
change the "release type" section to "final" e.g.:
11+
update the version number:
1212

1313
```python
14-
version_info = (0, 2, 3, "final")
14+
__version__ = "0.2.3"
1515
```
1616

1717
- Make a release commit and push to main
@@ -24,19 +24,11 @@ To cut a new Jupyter Sphinx release, follow these steps:
2424

2525
- [Create a new github release](https://github.com/jupyter/jupyter-sphinx/releases/new).
2626
The target should be **main**, the tag and the title should be the version number,
27-
e.g. `0.2.3`.
27+
e.g. `v0.2.3`.
2828

2929
- Creating the release in GitHub will push a tag commit to the repository, which will
3030
trigger [a GitHub action](https://github.com/jupyter/jupyter-sphinx/blob/main/.github/workflows/artifacts.yml)
3131
to build `jupyter-sphinx` and push the new version to PyPI.
3232
[Confirm that the version has been bumped](https://pypi.org/project/jupyter-sphinx/).
3333

34-
- In [`_version.py`](https://github.com/jupyter/jupyter-sphinx/blob/main/jupyter_sphinx/_version.py),
35-
bump the minor version and change the "release type" section to "alpha". **make sure to
36-
include a number after the release type**, e.g.:
37-
38-
```python
39-
version_info = (0, 2, 4, "alpha", 1)
40-
```
41-
4234
- That's it!

doc/Makefile

Lines changed: 0 additions & 26 deletions
This file was deleted.

doc/source/conf.py

Lines changed: 0 additions & 37 deletions
This file was deleted.

0 commit comments

Comments
 (0)