Skip to content

Use checkboxes for the releasing docs #95

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Nov 12, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions docs/_static/custom.css
Original file line number Diff line number Diff line change
Expand Up @@ -10,3 +10,17 @@ body {
html {
scroll-behavior: auto;
}

/* Make checkboxes from the tasklist extension ('- [ ]' in Markdown) not add bullet points to the checkboxes.

This can be removed once https://github.com/executablebooks/mdit-py-plugins/issues/59 is addressed.
*/

.contains-task-list {
list-style: none;
}

/* Make the checkboxes indented like they are bullets */
.task-list-item-checkbox {
margin: 0 0.2em 0.25em -1.4em;
}
3 changes: 2 additions & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,8 @@
templates_path = ['_templates']
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']

myst_enable_extensions = ["dollarmath", "linkify"]
myst_enable_extensions = ["dollarmath", "linkify", "tasklist"]
myst_enable_checkboxes = True

napoleon_use_rtype = False
napoleon_use_param = False
Expand Down
12 changes: 6 additions & 6 deletions docs/releasing.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,15 @@

To release array-api-strict:

- Create a release branch and make a PR on GitHub.
- [ ] Create a release branch and make a PR on GitHub.

- Update `changelog.md` with the changes for the release.
- [ ] Update `changelog.md` with the changes for the release.

- Make sure the CI is passing on the release branch PR. Also double check that
- [ ] Make sure the CI is passing on the release branch PR. Also double check that
you have properly pulled `main` and merged it into the release branch so
that the branch contains all the necessary changes for the release.

- When you are ready to make the release, create a tag with the release number
- [ ] When you are ready to make the release, create a tag with the release number

```
git tag -a 2.2 -m "array-api-strict 2.2"
Expand All @@ -30,8 +30,8 @@ To release array-api-strict:
in the package metadata is all automatically computed from the tag, so it is
not necessary to update the version anywhere else.

- Once the release is published, you can merge the PR.
- [ ] Once the release is published, you can merge the PR.

- The conda-forge bot will automatically send a PR to the
- [ ] The conda-forge bot will automatically send a PR to the
[array-api-strict-feedstock](https://github.com/conda-forge/array-api-strict-feedstock)
updating the version, which you should merge.
Loading