David Smith
43e4d0a142
Fixed #36485 -- Added lint-docs check in Tox and GitHub Actions.
...
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
ef2f16bc48
Refs #36485 -- Added sphinx-lint support and make lint rule for docs.
...
This adds a `lint.py` script to run sphinx-lint on Django's docs files,
a mathing `lint` target in the `docs/Makefile` and `docs/make.bat`, and
updates `docs/requirements.txt` accordingly.
2025-08-25 10:51:10 -03:00
David Smith
7f9bf357fe
Refs #36485 -- Grouped docs checks under a unified make check target.
...
Docs / docs (push) Waiting to run
Docs / blacken-docs (push) Waiting to run
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
Added a new 'check' rule to the docs Makefile which runs both the black
and spelling checks.
2025-08-05 12:18:19 -03: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
Susan Wright
7582d913e7
Added spelling option to make.bat.
2021-04-30 14:04:22 +02:00
Tim Graham
9b5f64cc6e
Fixed #19516 - Fixed remaining broken links.
...
Added -n to sphinx builds to catch issues going forward.
2013-01-02 18:32:57 -05:00
Claude Paroz
a79d920a56
Fixed #19266 -- Added Texinfo documentation target
...
Thanks orontee for the report and initial patch.
2012-11-09 09:00:27 +01:00
Claude Paroz
393aeb79b8
Added gettext target to sphinx makefiles.
...
This have been copied from sphinx-quickstart result in latest sphinx versions.
git-svn-id: http://code.djangoproject.com/svn/django/trunk@17877 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2012-04-07 22:35:57 +00:00
Jannis Leidel
8f7b5024b2
Fixed #16414 -- Added standard Windows make batch file for Sphinx. Thanks, Aymeric Augustin.
...
git-svn-id: http://code.djangoproject.com/svn/django/trunk@16547 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2011-07-19 09:00:24 +00:00
