Skip to content

Commit

Permalink
gh-86404: Doc: Drop now unused make suspicious and rstlint. (GH-98179)
Browse files Browse the repository at this point in the history
They have been replaced by
[sphinx-lint](https://github.com/sphinx-contrib/sphinx-lint).
  • Loading branch information
JulienPalard authored Oct 11, 2022
1 parent ad8e297 commit 4067c6d
Show file tree
Hide file tree
Showing 9 changed files with 10 additions and 1,082 deletions.
15 changes: 1 addition & 14 deletions Doc/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ ALLSPHINXOPTS = -b $(BUILDER) -d build/doctrees $(PAPEROPT_$(PAPER)) -j auto \
$(SPHINXOPTS) $(SPHINXERRORHANDLING) . build/$(BUILDER) $(SOURCES)

.PHONY: help build html htmlhelp latex text texinfo changes linkcheck \
suspicious coverage doctest pydoc-topics htmlview clean dist check serve \
coverage doctest pydoc-topics htmlview clean dist check serve \
autobuild-dev autobuild-stable venv

help:
Expand All @@ -42,7 +42,6 @@ help:
@echo " doctest to run doctests in the documentation"
@echo " pydoc-topics to regenerate the pydoc topics file"
@echo " dist to create a \"dist\" directory with archived docs for download"
@echo " suspicious to check for suspicious markup in output text"
@echo " check to run a check for frequent markup errors"

build:
Expand Down Expand Up @@ -110,18 +109,6 @@ linkcheck:
"or in build/$(BUILDER)/output.txt"; \
false; }

suspicious: BUILDER = suspicious
suspicious:
@$(MAKE) build BUILDER=$(BUILDER) || { \
echo "Suspicious check complete; look for any errors in the above output" \
"or in build/$(BUILDER)/suspicious.csv. If all issues are false" \
"positives, append that file to tools/susp-ignored.csv."; \
false; }
@echo "⚠ make suspicious is deprecated and will be removed soon."
@echo "⚠ Use:"
@echo "⚠ make check"
@echo "⚠ instead."

coverage: BUILDER = coverage
coverage: build
@echo "Coverage finished; see c.txt and python.txt in build/coverage"
Expand Down
3 changes: 0 additions & 3 deletions Doc/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -93,9 +93,6 @@ Available make targets are:
plain text documentation for the labels defined in
``tools/pyspecific.py`` -- pydoc needs these to show topic and keyword help.

* "suspicious", which checks the parsed markup for text that looks like
malformed and thus unconverted reST.

* "check", which checks for frequent markup errors.

* "serve", which serves the build/html directory on port 8000.
Expand Down
2 changes: 1 addition & 1 deletion Doc/make.bat
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,7 @@ echo.always available include:
echo.
echo. Provided by Sphinx:
echo. html, htmlhelp, latex, text
echo. suspicious, linkcheck, changes, doctest
echo. linkcheck, changes, doctest
echo. Provided by this script:
echo. clean, check, htmlview
echo.
Expand Down
5 changes: 0 additions & 5 deletions Doc/tools/extensions/pyspecific.py
Original file line number Diff line number Diff line change
Expand Up @@ -37,10 +37,6 @@
from sphinx.domains.python import PyClassmember as PyMethod
from sphinx.domains.python import PyModulelevel as PyFunction

# Support for checking for suspicious markup

import suspicious


ISSUE_URI = 'https://bugs.python.org/issue?@action=redirect&bpo=%s'
GH_ISSUE_URI = 'https://github.com/python/cpython/issues/%s'
Expand Down Expand Up @@ -686,7 +682,6 @@ def setup(app):
app.add_directive('audit-event-table', AuditEventListDirective)
app.add_directive('deprecated-removed', DeprecatedRemoved)
app.add_builder(PydocTopicsBuilder)
app.add_builder(suspicious.CheckSuspiciousMarkupBuilder)
app.add_object_type('opcode', 'opcode', '%s (opcode)', parse_opcode_signature)
app.add_object_type('pdbcommand', 'pdbcmd', '%s (pdb command)', parse_pdb_command)
app.add_object_type('2to3fixer', '2to3fixer', '%s (2to3 fixer)')
Expand Down
251 changes: 0 additions & 251 deletions Doc/tools/extensions/suspicious.py

This file was deleted.

Loading

0 comments on commit 4067c6d

Please sign in to comment.