From f16fbf940fdaec594eb1f4c5f9c61e926db53c5d Mon Sep 17 00:00:00 2001 From: Georg Brandl Date: Tue, 30 Sep 2014 22:51:30 +0200 Subject: [PATCH] Move Doc/tools/sphinxext content to Doc/tools, there is no need for the nested subdirectory anymore. --- Doc/Makefile | 4 +- Doc/README.txt | 3 +- Doc/conf.py | 6 +- Doc/make.bat | 2 +- Doc/tools/{sphinxext => }/c_annotations.py | 0 Doc/tools/{sphinxext => }/download.html | 0 Doc/tools/{sphinxext => }/indexcontent.html | 0 Doc/tools/{sphinxext => }/indexsidebar.html | 0 Doc/tools/{sphinxext => }/layout.html | 0 Doc/tools/{sphinxext => }/opensearch.xml | 0 Doc/tools/{sphinxext => }/patchlevel.py | 0 Doc/tools/{sphinxext => }/pyspecific.py | 0 Doc/tools/roman.py | 80 ------------------ Doc/tools/sphinx-build.py | 28 ------ Doc/tools/{sphinxext => }/static/basic.css | 0 .../{sphinxext => }/static/copybutton.js | 0 Doc/tools/{sphinxext => }/static/py.png | Bin Doc/tools/{sphinxext => }/static/sidebar.js | 0 .../{sphinxext => }/static/version_switch.js | 0 Doc/tools/{sphinxext => }/susp-ignored.csv | 0 Doc/tools/{sphinxext => }/suspicious.py | 0 Lib/pydoc.py | 2 +- 22 files changed, 8 insertions(+), 117 deletions(-) rename Doc/tools/{sphinxext => }/c_annotations.py (100%) rename Doc/tools/{sphinxext => }/download.html (100%) rename Doc/tools/{sphinxext => }/indexcontent.html (100%) rename Doc/tools/{sphinxext => }/indexsidebar.html (100%) rename Doc/tools/{sphinxext => }/layout.html (100%) rename Doc/tools/{sphinxext => }/opensearch.xml (100%) rename Doc/tools/{sphinxext => }/patchlevel.py (100%) rename Doc/tools/{sphinxext => }/pyspecific.py (100%) delete mode 100644 Doc/tools/roman.py delete mode 100644 Doc/tools/sphinx-build.py rename Doc/tools/{sphinxext => }/static/basic.css (100%) rename Doc/tools/{sphinxext => }/static/copybutton.js (100%) rename Doc/tools/{sphinxext => }/static/py.png (100%) rename Doc/tools/{sphinxext => }/static/sidebar.js (100%) rename Doc/tools/{sphinxext => }/static/version_switch.js (100%) rename Doc/tools/{sphinxext => }/susp-ignored.csv (100%) rename Doc/tools/{sphinxext => }/suspicious.py (100%) diff --git a/Doc/Makefile b/Doc/Makefile index fee7fc795a01c2..5b5f68a0f3e068 100644 --- a/Doc/Makefile +++ b/Doc/Makefile @@ -8,7 +8,7 @@ PYTHON = python SPHINXBUILD = sphinx-build PAPER = SOURCES = -DISTVERSION = $(shell $(PYTHON) tools/sphinxext/patchlevel.py) +DISTVERSION = $(shell $(PYTHON) tools/patchlevel.py) ALLSPHINXOPTS = -b $(BUILDER) -d build/doctrees -D latex_paper_size=$(PAPER) \ $(SPHINXOPTS) . build/$(BUILDER) $(SOURCES) @@ -79,7 +79,7 @@ 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/sphinxext/susp-ignored.csv."; \ + "positives, append that file to tools/susp-ignored.csv."; \ false; } coverage: BUILDER = coverage diff --git a/Doc/README.txt b/Doc/README.txt index fed1f749c0a352..885b555212502d 100644 --- a/Doc/README.txt +++ b/Doc/README.txt @@ -79,8 +79,7 @@ Available make targets are: * "pydoc-topics", which builds a Python module containing a dictionary with plain text documentation for the labels defined in - `tools/sphinxext/pyspecific.py` -- pydoc needs these to show topic and - keyword help. + `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. diff --git a/Doc/conf.py b/Doc/conf.py index c90ed59c04616c..4051a56e9d2cda 100644 --- a/Doc/conf.py +++ b/Doc/conf.py @@ -8,14 +8,14 @@ # that aren't pickleable (module imports are okay, they're removed automatically). import sys, os, time -sys.path.append(os.path.abspath('tools/sphinxext')) +sys.path.append(os.path.abspath('tools')) # General configuration # --------------------- extensions = ['sphinx.ext.coverage', 'sphinx.ext.doctest', 'pyspecific', 'c_annotations'] -templates_path = ['tools/sphinxext'] +templates_path = ['tools'] # General substitutions. project = 'Python' @@ -89,7 +89,7 @@ html_use_opensearch = 'http://docs.python.org/' # Additional static files. -html_static_path = ['tools/sphinxext/static'] +html_static_path = ['tools/static'] # Output file base name for HTML help builder. htmlhelp_basename = 'python' + release.replace('.', '') diff --git a/Doc/make.bat b/Doc/make.bat index b26826ef145ebf..c8f608252e85ed 100644 --- a/Doc/make.bat +++ b/Doc/make.bat @@ -12,7 +12,7 @@ if DEFINED ProgramFiles(x86) set _PRGMFLS=%ProgramFiles(x86)% if NOT DEFINED ProgramFiles(x86) set _PRGMFLS=%ProgramFiles% if "%HTMLHELP%" EQU "" set HTMLHELP=%_PRGMFLS%\HTML Help Workshop\hhc.exe -if "%DISTVERSION%" EQU "" for /f "usebackq" %%v in (`%PYTHON% tools/sphinxext/patchlevel.py`) do set DISTVERSION=%%v +if "%DISTVERSION%" EQU "" for /f "usebackq" %%v in (`%PYTHON% tools/patchlevel.py`) do set DISTVERSION=%%v if "%BUILDDIR%" EQU "" set BUILDDIR=build diff --git a/Doc/tools/sphinxext/c_annotations.py b/Doc/tools/c_annotations.py similarity index 100% rename from Doc/tools/sphinxext/c_annotations.py rename to Doc/tools/c_annotations.py diff --git a/Doc/tools/sphinxext/download.html b/Doc/tools/download.html similarity index 100% rename from Doc/tools/sphinxext/download.html rename to Doc/tools/download.html diff --git a/Doc/tools/sphinxext/indexcontent.html b/Doc/tools/indexcontent.html similarity index 100% rename from Doc/tools/sphinxext/indexcontent.html rename to Doc/tools/indexcontent.html diff --git a/Doc/tools/sphinxext/indexsidebar.html b/Doc/tools/indexsidebar.html similarity index 100% rename from Doc/tools/sphinxext/indexsidebar.html rename to Doc/tools/indexsidebar.html diff --git a/Doc/tools/sphinxext/layout.html b/Doc/tools/layout.html similarity index 100% rename from Doc/tools/sphinxext/layout.html rename to Doc/tools/layout.html diff --git a/Doc/tools/sphinxext/opensearch.xml b/Doc/tools/opensearch.xml similarity index 100% rename from Doc/tools/sphinxext/opensearch.xml rename to Doc/tools/opensearch.xml diff --git a/Doc/tools/sphinxext/patchlevel.py b/Doc/tools/patchlevel.py similarity index 100% rename from Doc/tools/sphinxext/patchlevel.py rename to Doc/tools/patchlevel.py diff --git a/Doc/tools/sphinxext/pyspecific.py b/Doc/tools/pyspecific.py similarity index 100% rename from Doc/tools/sphinxext/pyspecific.py rename to Doc/tools/pyspecific.py diff --git a/Doc/tools/roman.py b/Doc/tools/roman.py deleted file mode 100644 index 89ef617e6e7172..00000000000000 --- a/Doc/tools/roman.py +++ /dev/null @@ -1,80 +0,0 @@ -"""Convert to and from Roman numerals""" - -__author__ = "Mark Pilgrim (f8dy@diveintopython.org)" -__version__ = "1.4" -__date__ = "8 August 2001" -__copyright__ = """Copyright (c) 2001 Mark Pilgrim - -This program is part of "Dive Into Python", a free Python tutorial for -experienced programmers. Visit http://diveintopython.org/ for the -latest version. - -This program is free software; you can redistribute it and/or modify -it under the terms of the Python 2.1.1 license, available at -http://www.python.org/2.1.1/license.html -""" - -import re - -#Define exceptions -class RomanError(Exception): pass -class OutOfRangeError(RomanError): pass -class NotIntegerError(RomanError): pass -class InvalidRomanNumeralError(RomanError): pass - -#Define digit mapping -romanNumeralMap = (('M', 1000), - ('CM', 900), - ('D', 500), - ('CD', 400), - ('C', 100), - ('XC', 90), - ('L', 50), - ('XL', 40), - ('X', 10), - ('IX', 9), - ('V', 5), - ('IV', 4), - ('I', 1)) - -def toRoman(n): - """convert integer to Roman numeral""" - if not (0 < n < 5000): - raise OutOfRangeError("number out of range (must be 1..4999)") - if int(n) != n: - raise NotIntegerError("decimals can not be converted") - - result = "" - for numeral, integer in romanNumeralMap: - while n >= integer: - result += numeral - n -= integer - return result - -#Define pattern to detect valid Roman numerals -romanNumeralPattern = re.compile(""" - ^ # beginning of string - M{0,4} # thousands - 0 to 4 M's - (CM|CD|D?C{0,3}) # hundreds - 900 (CM), 400 (CD), 0-300 (0 to 3 C's), - # or 500-800 (D, followed by 0 to 3 C's) - (XC|XL|L?X{0,3}) # tens - 90 (XC), 40 (XL), 0-30 (0 to 3 X's), - # or 50-80 (L, followed by 0 to 3 X's) - (IX|IV|V?I{0,3}) # ones - 9 (IX), 4 (IV), 0-3 (0 to 3 I's), - # or 5-8 (V, followed by 0 to 3 I's) - $ # end of string - """ ,re.VERBOSE) - -def fromRoman(s): - """convert Roman numeral to integer""" - if not s: - raise InvalidRomanNumeralError('Input can not be blank') - if not romanNumeralPattern.search(s): - raise InvalidRomanNumeralError('Invalid Roman numeral: %s' % s) - - result = 0 - index = 0 - for numeral, integer in romanNumeralMap: - while s[index:index+len(numeral)] == numeral: - result += integer - index += len(numeral) - return result diff --git a/Doc/tools/sphinx-build.py b/Doc/tools/sphinx-build.py deleted file mode 100644 index d3fe7026b1311b..00000000000000 --- a/Doc/tools/sphinx-build.py +++ /dev/null @@ -1,28 +0,0 @@ -# -*- coding: utf-8 -*- -""" - Sphinx - Python documentation toolchain - ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - - :copyright: 2007-2010 by Georg Brandl. - :license: Python license. -""" - -import sys -import warnings - -# Get rid of UserWarnings reported by pkg_resources. -warnings.filterwarnings('ignore', category=UserWarning, module='jinja2') - -if __name__ == '__main__': - - if sys.version_info[:3] < (2, 4, 0) or sys.version_info[:3] > (3, 0, 0): - sys.stderr.write("""\ -Error: Sphinx needs to be executed with Python 2.4 or newer (not 3.x though). -(If you run this from the Makefile, you can set the PYTHON variable -to the path of an alternative interpreter executable, e.g., -``make html PYTHON=python2.5``). -""") - sys.exit(1) - - from sphinx import main - sys.exit(main(sys.argv)) diff --git a/Doc/tools/sphinxext/static/basic.css b/Doc/tools/static/basic.css similarity index 100% rename from Doc/tools/sphinxext/static/basic.css rename to Doc/tools/static/basic.css diff --git a/Doc/tools/sphinxext/static/copybutton.js b/Doc/tools/static/copybutton.js similarity index 100% rename from Doc/tools/sphinxext/static/copybutton.js rename to Doc/tools/static/copybutton.js diff --git a/Doc/tools/sphinxext/static/py.png b/Doc/tools/static/py.png similarity index 100% rename from Doc/tools/sphinxext/static/py.png rename to Doc/tools/static/py.png diff --git a/Doc/tools/sphinxext/static/sidebar.js b/Doc/tools/static/sidebar.js similarity index 100% rename from Doc/tools/sphinxext/static/sidebar.js rename to Doc/tools/static/sidebar.js diff --git a/Doc/tools/sphinxext/static/version_switch.js b/Doc/tools/static/version_switch.js similarity index 100% rename from Doc/tools/sphinxext/static/version_switch.js rename to Doc/tools/static/version_switch.js diff --git a/Doc/tools/sphinxext/susp-ignored.csv b/Doc/tools/susp-ignored.csv similarity index 100% rename from Doc/tools/sphinxext/susp-ignored.csv rename to Doc/tools/susp-ignored.csv diff --git a/Doc/tools/sphinxext/suspicious.py b/Doc/tools/suspicious.py similarity index 100% rename from Doc/tools/sphinxext/suspicious.py rename to Doc/tools/suspicious.py diff --git a/Lib/pydoc.py b/Lib/pydoc.py index 218fd30d50e93a..dfa1f8e36bd791 100755 --- a/Lib/pydoc.py +++ b/Lib/pydoc.py @@ -1599,7 +1599,7 @@ class Helper: # in pydoc_data/topics.py. # # CAUTION: if you change one of these dictionaries, be sure to adapt the - # list of needed labels in Doc/tools/sphinxext/pyspecific.py and + # list of needed labels in Doc/tools/pyspecific.py and # regenerate the pydoc_data/topics.py file by running # make pydoc-topics # in Doc/ and copying the output file into the Lib/ directory.