Skip to content
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

bpo-42238: [doc] moving from rstlint.py to sphinx-lint. #31097

Merged
merged 5 commits into from
Feb 10, 2022
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
5 changes: 3 additions & 2 deletions Doc/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
PYTHON = python3
VENVDIR = ./venv
SPHINXBUILD = PATH=$(VENVDIR)/bin:$$PATH sphinx-build
SPHINXLINT = PATH=$(VENVDIR)/bin:$$PATH sphinx-lint
BLURB = PATH=$(VENVDIR)/bin:$$PATH blurb
PAPER =
SOURCES =
Expand Down Expand Up @@ -214,8 +215,8 @@ dist:
rm dist/python-$(DISTVERSION)-docs-texinfo.tar

check:
$(PYTHON) tools/rstlint.py -i tools -i $(VENVDIR) -i README.rst
$(PYTHON) tools/rstlint.py ../Misc/NEWS.d/next/
$(SPHINXLINT) -i tools -i $(VENVDIR) -i README.rst
$(SPHINXLINT) ../Misc/NEWS.d/next/

serve:
$(PYTHON) ../Tools/scripts/serve.py build/html $(SERVE_PORT)
Expand Down
12 changes: 11 additions & 1 deletion Doc/make.bat
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,16 @@ if not defined BLURB (
set BLURB=%PYTHON% -m blurb
)

if not defined SPHINXLINT (
%PYTHON% -c "import sphinxlint" > nul 2> nul
if errorlevel 1 (
echo Installing sphinx-lint with %PYTHON%
%PYTHON% -m pip install sphinx-lint
if errorlevel 1 exit /B
)
set SPHINXLINT=%PYTHON% -m sphinxlint
)

if "%1" NEQ "htmlhelp" goto :skiphhcsearch
if exist "%HTMLHELP%" goto :skiphhcsearch

Expand Down Expand Up @@ -168,7 +178,7 @@ if EXIST "%BUILDDIR%\html\index.html" (
goto end

:check
cmd /S /C "%PYTHON% tools\rstlint.py -i tools"
cmd /S /C "%SPHINXLINT% -i tools"
goto end

:serve
Expand Down
2 changes: 2 additions & 0 deletions Doc/requirements.txt
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@ sphinx==4.2.0

blurb

sphinx-lint<1

# The theme used by the documentation is stored separately, so we need
# to install that as well.
python-docs-theme>=2022.1
5 changes: 5 additions & 0 deletions Doc/tools/rstlint.py
100755 → 100644
Original file line number Diff line number Diff line change
Expand Up @@ -345,6 +345,11 @@ def main(argv):

count = defaultdict(int)

print("""⚠ rstlint.py is no longer maintained here and will be removed
⚠ in a future release.
⚠ Please use https://pypi.org/p/sphinx-lint instead.
""")

for root, dirs, files in os.walk(path):
# ignore subdirs in ignore list
if abspath(root) in ignore:
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
``Doc/tools/rstlint.py`` has moved to its own repository and is now packaged
on PyPI as ``sphinx-lint``.
Original file line number Diff line number Diff line change
@@ -1 +1 @@
In :func:`typing.get_type_hints`, support evaluating bare stringified ``TypeAlias`` annotations. Patch by Gregory Beauregard.
In :func:`typing.get_type_hints`, support evaluating bare stringified ``TypeAlias`` annotations. Patch by Gregory Beauregard.