diff options
| author | David Smith <smithdc@gmail.com> | 2025-06-25 21:40:07 +0100 |
|---|---|---|
| committer | Natalia <124304+nessita@users.noreply.github.com> | 2025-08-05 12:20:13 -0300 |
| commit | a9c7d4b703759e9903dd92899dd8ac662007baf3 (patch) | |
| tree | 843808a338237963f0f8593281e6aff2f481b31e /docs/make.bat | |
| parent | 5ad6d43cd9ae05d3575f9e7bb1cb488bce5d905d (diff) | |
[5.2.x] Refs #36485 -- Grouped docs checks under a unified make check target.
Added a new 'check' rule to the docs Makefile which runs both the black
and spelling checks.
Backport of 7f9bf357feac06bb34017e1f6c7a7730b1991ede from main.
Diffstat (limited to 'docs/make.bat')
| -rw-r--r-- | docs/make.bat | 28 |
1 files changed, 22 insertions, 6 deletions
diff --git a/docs/make.bat b/docs/make.bat index 72d71136c2..8376db57f0 100644 --- a/docs/make.bat +++ b/docs/make.bat @@ -189,20 +189,36 @@ results in %BUILDDIR%/doctest/output.txt. ) if "%1" == "spelling" ( - %SPHINXBUILD% -b spelling %ALLSPHINXOPTS% %BUILDDIR%/spelling - if errorlevel 1 exit /b 1 - echo. - echo.Check finished. Wrong words can be found in %BUILDDIR%/^ -spelling/output.txt. + call :run_spelling goto end ) if "%1" == "black" ( + call :run_black + goto end +) + +if "%1" == "check" ( + call :run_black + call :run_spelling + echo. + echo.All checks completed. + goto end +) + +:run_spelling + %SPHINXBUILD% -b spelling %ALLSPHINXOPTS% %BUILDDIR%/spelling + if errorlevel 1 exit /b 1 + echo. + echo.Check finished. Wrong words can be found in %BUILDDIR%/spelling/output.txt. + exit /b + +:run_black for /f "usebackq tokens=*" %%i in (`dir *.txt /s /b ^| findstr /v /c:"_build" /c:"_theme"`) do ( blacken-docs --rst-literal-block %%i ) echo. echo.Code blocks reformatted -) + exit /b :end |