Merge pull request #95 from asmeurer/checkboxes

Use checkboxes for the releasing docs

Author: asmeurer

docs/_static/custom.css

@@ -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;
+}

docs/conf.py

@@ -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

docs/releasing.md

@@ -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"
@@ -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.