Commit graph

18 commits

Author SHA1 Message Date
David Smith
43e4d0a142 Fixed #36485 -- Added lint-docs check in Tox and GitHub Actions.
Some checks are pending
Docs / spelling (push) Waiting to run
Docs / blacken-docs (push) Waiting to run
Linters / flake8 (push) Waiting to run
Tests / Windows, SQLite, Python 3.13 (push) Waiting to run
Tests / JavaScript tests (push) Waiting to run
Docs / lint-docs (push) Waiting to run
Linters / isort (push) Waiting to run
Linters / black (push) Waiting to run
The `check` docs target now runs spelling, black, and lint, so all
current documentation quality checks can be run with a single command.

Also documented the lint-docs check's availability and usage.
2025-08-25 10:51:10 -03:00
David Smith
7a80e29fea Improved docs.yml GitHub Action covering docs quality checks.
Some checks failed
Docs / spelling (push) Has been cancelled
Docs / blacken-docs (push) Has been cancelled
Linters / flake8 (push) Has been cancelled
Linters / isort (push) Has been cancelled
Linters / black (push) Has been cancelled
Tests / Windows, SQLite, Python 3.13 (push) Has been cancelled
Tests / JavaScript tests (push) Has been cancelled
This change renames the `docs` job to `spelling` to better reflect its
purpose. It also removes the unused `--keep-going` flag, since starting
with Sphinx 8.1, `--keep-going` is enabled by default.

See:
https://www.sphinx-doc.org/en/master/man/sphinx-build.html#cmdoption-sphinx-build-keep-going
2025-08-08 16:39:50 -03:00
David Smith
73d532d9a9
Upgraded to Python 3.12, Ubuntu 24.04, and enabled fail_on_warning for docs builds. 2024-11-27 15:20:49 -03:00
Mariusz Felisiak
f07eeff3a2 Refs #34900 -- Added Python 3.12 to classifiers and tox.ini, and used it in GitHub actions. 2024-10-09 09:27:33 +02:00
Mariusz Felisiak
e676f56527
Bumped versions in Github actions configuration. 2024-01-26 13:41:52 +01:00
Mariusz Felisiak
19c4052f98
Refs #34118 -- Used Python 3.12 for GitHub actions. 2023-11-18 16:58:25 +01:00
Mariusz Felisiak
4f0c0e6fa1
Bumped checkout version in Github actions configuration. 2023-09-05 10:52:17 +02:00
Mariusz Felisiak
6015bab80e Refs #34140 -- Added configurations to run blacken-docs linter and adjusted docs.
This adds:
- GitHub actions,
- tox configuration,
- pre-commit hook, and
- makefile rules
to run blacken-docs linter.

Co-authored-by: David Smith <smithdc@gmail.com>
2023-03-01 13:02:57 +01:00
Mariusz Felisiak
2e82fa54ca Refs #33173 -- Used Python 3.11 for GitHub actions. 2022-10-26 09:42:51 +02:00
Mariusz Felisiak
5f76002500
Restricted permissions for GitHub tokens. 2022-08-04 20:00:35 +02:00
Mariusz Felisiak
9a22d1769b
Bumped versions in Github actions configuration. 2022-06-24 07:38:13 +02:00
Mariusz Felisiak
d9fc383a5e
Used Ubuntu 20.04 for docs GitHub action. 2022-03-08 09:29:32 +01:00
Mariusz Felisiak
c121e32082
Made Github actions auto-cancel redundant jobs. 2022-03-07 13:17:58 +01:00
Mariusz Felisiak
4468bcc657
Bumped versions in Github actions configuration to v3. 2022-03-07 10:56:31 +01:00
Mariusz Felisiak
5b0f1f95d0 Used Python 3.10 for docs and linters GitHub actions. 2021-10-11 20:52:58 +02:00
Mariusz Felisiak
01eed04155
Used Ubuntu 18.04 for docs GitHub action. 2021-07-29 11:54:14 +02:00
Markus Holtermann
a124365de8 Updated Git branch "master" to "main" in GitHub actions workflows. 2021-03-09 07:28:49 +01:00
Mariusz Felisiak
9f125fce79 Used GitHub actions for docs tests.
Co-Authored-By: Tom Forbes <tom@tomforb.es>
2021-02-26 22:12:25 +01:00