[Python-checkins] cpython (2.7): Move Sphinx templates and extensions to their own subdirs.
georg.brandl
python-checkins at python.org
Wed Oct 29 08:47:09 CET 2014
https://hg.python.org/cpython/rev/71064ad150bd
changeset: 93227:71064ad150bd
branch: 2.7
parent: 93212:367db2730b05
user: Georg Brandl <georg at python.org>
date: Wed Oct 29 08:41:02 2014 +0100
summary:
Move Sphinx templates and extensions to their own subdirs.
files:
Doc/conf.py | 34 ++++++------------------
Doc/tools/c_annotations.py | 0
Doc/tools/patchlevel.py | 0
Doc/tools/pyspecific.py | 0
Doc/tools/suspicious.py | 2 +-
Doc/tools/download.html | 0
Doc/tools/indexcontent.html | 0
Doc/tools/indexsidebar.html | 0
Doc/tools/layout.html | 0
Doc/tools/opensearch.xml | 0
10 files changed, 10 insertions(+), 26 deletions(-)
diff --git a/Doc/conf.py b/Doc/conf.py
--- a/Doc/conf.py
+++ b/Doc/conf.py
@@ -8,26 +8,18 @@
# that aren't pickleable (module imports are okay, they're removed automatically).
import sys, os, time
-sys.path.append(os.path.abspath('tools'))
+sys.path.append(os.path.abspath('tools/extensions'))
# General configuration
# ---------------------
extensions = ['sphinx.ext.coverage', 'sphinx.ext.doctest',
'pyspecific', 'c_annotations']
-templates_path = ['tools']
# General substitutions.
project = 'Python'
copyright = '1990-%s, Python Software Foundation' % time.strftime('%Y')
-# The default replacements for |version| and |release|.
-#
-# The short X.Y version.
-# version = '2.6'
-# The full version, including alpha/beta/rc tags.
-# release = '2.6a0'
-
# We look for the Include/patchlevel.h file in the current Python source tree
# and replace the values accordingly.
import patchlevel
@@ -46,19 +38,6 @@
'library/xml.etree.rst',
]
-# Ignore .rst in Sphinx its self.
-exclude_trees = ['tools/sphinx']
-
-# Relative filename of the reference count data file.
-refcount_file = 'data/refcounts.dat'
-
-# If true, '()' will be appended to :func: etc. cross-reference text.
-add_function_parentheses = True
-
-# If true, the current module name will be prepended to all description
-# unit titles (such as .. function::).
-add_module_names = True
-
# Require Sphinx 1.2 for build.
needs_sphinx = '1.2'
@@ -73,9 +52,8 @@
# using the given strftime format.
html_last_updated_fmt = '%b %d, %Y'
-# If true, SmartyPants will be used to convert quotes and dashes to
-# typographically correct entities.
-html_use_smartypants = True
+# Path to find HTML templates.
+templates_path = ['tools/templates']
# Custom sidebar templates, filenames relative to this file.
html_sidebars = {
@@ -192,3 +170,9 @@
coverage_ignore_c_items = {
# 'cfunction': [...]
}
+
+# Options for extensions
+# ----------------------
+
+# Relative filename of the reference count data file.
+refcount_file = 'data/refcounts.dat'
diff --git a/Doc/tools/c_annotations.py b/Doc/tools/extensions/c_annotations.py
rename from Doc/tools/c_annotations.py
rename to Doc/tools/extensions/c_annotations.py
diff --git a/Doc/tools/patchlevel.py b/Doc/tools/extensions/patchlevel.py
rename from Doc/tools/patchlevel.py
rename to Doc/tools/extensions/patchlevel.py
diff --git a/Doc/tools/pyspecific.py b/Doc/tools/extensions/pyspecific.py
rename from Doc/tools/pyspecific.py
rename to Doc/tools/extensions/pyspecific.py
diff --git a/Doc/tools/suspicious.py b/Doc/tools/extensions/suspicious.py
rename from Doc/tools/suspicious.py
rename to Doc/tools/extensions/suspicious.py
--- a/Doc/tools/suspicious.py
+++ b/Doc/tools/extensions/suspicious.py
@@ -91,7 +91,7 @@
self.log_file_name = os.path.join(self.outdir, 'suspicious.csv')
open(self.log_file_name, 'w').close()
# load database of previously ignored issues
- self.load_rules(os.path.join(os.path.dirname(__file__),
+ self.load_rules(os.path.join(os.path.dirname(__file__), '..',
'susp-ignored.csv'))
def get_outdated_docs(self):
diff --git a/Doc/tools/download.html b/Doc/tools/templates/download.html
rename from Doc/tools/download.html
rename to Doc/tools/templates/download.html
diff --git a/Doc/tools/indexcontent.html b/Doc/tools/templates/indexcontent.html
rename from Doc/tools/indexcontent.html
rename to Doc/tools/templates/indexcontent.html
diff --git a/Doc/tools/indexsidebar.html b/Doc/tools/templates/indexsidebar.html
rename from Doc/tools/indexsidebar.html
rename to Doc/tools/templates/indexsidebar.html
diff --git a/Doc/tools/layout.html b/Doc/tools/templates/layout.html
rename from Doc/tools/layout.html
rename to Doc/tools/templates/layout.html
diff --git a/Doc/tools/opensearch.xml b/Doc/tools/templates/opensearch.xml
rename from Doc/tools/opensearch.xml
rename to Doc/tools/templates/opensearch.xml
--
Repository URL: https://hg.python.org/cpython
More information about the Python-checkins
mailing list