diff options
author | Georg Brandl <georg@python.org> | 2014-10-29 08:41:02 +0100 |
---|---|---|
committer | Georg Brandl <georg@python.org> | 2014-10-29 08:41:02 +0100 |
commit | 160cbce92adc3ccbe4ae6e231ea27fb5ff28dca9 (patch) | |
tree | ceeec64ece058d00549a8c1094d1ba23ad26ba9a | |
parent | 8a91c5b9999adea77031caf7e96b419b67d8a386 (diff) | |
download | cpython-git-160cbce92adc3ccbe4ae6e231ea27fb5ff28dca9.tar.gz |
Move Sphinx templates and extensions to their own subdirs.
-rw-r--r-- | Doc/conf.py | 34 | ||||
-rw-r--r-- | Doc/tools/extensions/c_annotations.py (renamed from Doc/tools/c_annotations.py) | 0 | ||||
-rw-r--r-- | Doc/tools/extensions/patchlevel.py (renamed from Doc/tools/patchlevel.py) | 0 | ||||
-rw-r--r-- | Doc/tools/extensions/pyspecific.py (renamed from Doc/tools/pyspecific.py) | 0 | ||||
-rw-r--r-- | Doc/tools/extensions/suspicious.py (renamed from Doc/tools/suspicious.py) | 2 | ||||
-rw-r--r-- | Doc/tools/templates/download.html (renamed from Doc/tools/download.html) | 0 | ||||
-rw-r--r-- | Doc/tools/templates/indexcontent.html (renamed from Doc/tools/indexcontent.html) | 0 | ||||
-rw-r--r-- | Doc/tools/templates/indexsidebar.html (renamed from Doc/tools/indexsidebar.html) | 0 | ||||
-rw-r--r-- | Doc/tools/templates/layout.html (renamed from Doc/tools/layout.html) | 0 | ||||
-rw-r--r-- | Doc/tools/templates/opensearch.xml (renamed from Doc/tools/opensearch.xml) | 0 |
10 files changed, 10 insertions, 26 deletions
diff --git a/Doc/conf.py b/Doc/conf.py index 8bf52f7f81..ca42f93f71 100644 --- 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 @@ exclude_patterns = [ '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 @@ html_theme_options = {'collapsiblesidebar': True} # 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_c_regexes = { 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 index baa39f3b44..baa39f3b44 100644 --- a/Doc/tools/c_annotations.py +++ b/Doc/tools/extensions/c_annotations.py diff --git a/Doc/tools/patchlevel.py b/Doc/tools/extensions/patchlevel.py index b070d60a42..b070d60a42 100644 --- a/Doc/tools/patchlevel.py +++ b/Doc/tools/extensions/patchlevel.py diff --git a/Doc/tools/pyspecific.py b/Doc/tools/extensions/pyspecific.py index 169989180c..169989180c 100644 --- a/Doc/tools/pyspecific.py +++ b/Doc/tools/extensions/pyspecific.py diff --git a/Doc/tools/suspicious.py b/Doc/tools/extensions/suspicious.py index ee877336f6..d3ed849157 100644 --- a/Doc/tools/suspicious.py +++ b/Doc/tools/extensions/suspicious.py @@ -91,7 +91,7 @@ class CheckSuspiciousMarkupBuilder(Builder): 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 index 3adf2e92d3..3adf2e92d3 100644 --- a/Doc/tools/download.html +++ b/Doc/tools/templates/download.html diff --git a/Doc/tools/indexcontent.html b/Doc/tools/templates/indexcontent.html index 7f8547020f..7f8547020f 100644 --- a/Doc/tools/indexcontent.html +++ b/Doc/tools/templates/indexcontent.html diff --git a/Doc/tools/indexsidebar.html b/Doc/tools/templates/indexsidebar.html index 5c4c75d6ad..5c4c75d6ad 100644 --- a/Doc/tools/indexsidebar.html +++ b/Doc/tools/templates/indexsidebar.html diff --git a/Doc/tools/layout.html b/Doc/tools/templates/layout.html index f24dc8c755..f24dc8c755 100644 --- a/Doc/tools/layout.html +++ b/Doc/tools/templates/layout.html diff --git a/Doc/tools/opensearch.xml b/Doc/tools/templates/opensearch.xml index 69cec804cd..69cec804cd 100644 --- a/Doc/tools/opensearch.xml +++ b/Doc/tools/templates/opensearch.xml |