GV

GeezerVison

The World Wide Web, restored to 800 pixels of glory.

Home|About|Gaming cabinet|Archives|How it works|Starter sites

On this site

  • Sign in
  • ActionsCI/CD and automation
  • CodespacesCloud development environments
  • All Features
  • Documentation
  • Training
  • Certifications
  • Build with Copilot
  • Customize Copilot
  • Integrations
  • Trending repos
  • GitHub Sponsors
  • Developer articles
  • Enterprises

This view

  • Original page
  • New address

GeezerVison is showing github.com — bpo-42238: [doc] moving from rstlint.py to sphinx-lint. by JulienPalard · Pull Request #31097 · python/cpython

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

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.

Sign up for GitHub

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

Merged
JulienPalard merged 5 commits into python:main from JulienPalard:mdk-sphinx-lint
Feb 10, 2022

Uh oh!

There was an error while loading. Please reload this page.
Merged

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
ffb8f98
bpo-42238: [doc] moving from rstlint.py to sphinx-lint.
JulienPalard Feb 3, 2022
22da852
Add news.
JulienPalard Feb 3, 2022
a9bc65f
Pin a bit, just in case we want to release breaking changes.
JulienPalard Feb 3, 2022
ee7f4d9
Don't drop the file that soon, notify about its move instead.
JulienPalard Feb 7, 2022
9b02019
FIX: Missing newline at end of file.
JulienPalard Feb 7, 2022
File filter
Filter by extension
Clear filters
Conversations
Failed to load comments.
Loading

Uh oh!

There was an error while loading. Please reload this page.
Jump to
Jump to file
Failed to load files.
Loading

Uh oh!

There was an error while loading. Please reload this page.
Diff view
Diff view

There are no files selected for viewing

5 changes: 3 additions & 2 deletions 5 Doc/Makefile
Show comments
View file
Open in desktop
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 12 Doc/make.bat
Show comments
View file
Open in desktop
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 2 Doc/requirements.txt
Show comments
View file
Open in desktop
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 5 Doc/tools/rstlint.py
100755 → 100644
Show comments
View file
Open in desktop
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
2 changes: 2 additions & 0 deletions 2 Misc/NEWS.d/next/Documentation/2022-02-03-11-24-59.bpo-42238.yJcMa8.rst
Show comments
View file
Open in desktop
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``.
2 changes: 1 addition & 1 deletion 2 Misc/NEWS.d/next/Library/2022-02-06-08-54-03.bpo-46655.DiLzYv.rst
Show comments
View file
Open in desktop
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.
Add this suggestion to a batch that can be applied as a single commit. This suggestion is invalid because no changes were made to the code. Suggestions cannot be applied while the pull request is closed. Suggestions cannot be applied while viewing a subset of changes. Only one suggestion per line can be applied in a batch. Add this suggestion to a batch that can be applied as a single commit. Applying suggestions on deleted lines is not supported. You must change the existing code in this line in order to create a valid suggestion. Outdated suggestions cannot be applied. This suggestion has been applied or marked resolved. Suggestions cannot be applied from pending reviews. Suggestions cannot be applied on multi-line comments. Suggestions cannot be applied while the pull request is queued to merge. Suggestion cannot be applied right now. Please check back later.
You are visitor 01402503 — GeezerVison does not store the pages you look up.
Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required.