Georg Brandl | 8ec7f65 | 2007-08-15 14:28:01 +0000 | [diff] [blame] | 1 | # -*- coding: utf-8 -*- |
| 2 | # |
| 3 | # Python documentation build configuration file |
| 4 | # |
| 5 | # The contents of this file are pickled, so don't put values in the namespace |
| 6 | # that aren't pickleable (module imports are okay, they're removed automatically). |
| 7 | # |
| 8 | |
| 9 | # The default replacements for |version| and |release|. |
| 10 | # If 'auto', Sphinx looks for the Include/patchlevel.h file in the current Python |
| 11 | # source tree and replaces the values accordingly. |
| 12 | # |
| 13 | # The short X.Y version. |
| 14 | # version = '2.6' |
| 15 | version = 'auto' |
| 16 | # The full version, including alpha/beta/rc tags. |
| 17 | # release = '2.6a0' |
| 18 | release = 'auto' |
| 19 | |
| 20 | # There are two options for replacing |today|: either, you set today to some |
| 21 | # non-false value, then it is used: |
| 22 | today = '' |
| 23 | # Else, today_fmt is used as the format for a strftime call. |
| 24 | today_fmt = '%B %d, %Y' |
| 25 | |
| 26 | # The base URL for download links. |
| 27 | download_base_url = 'http://docs.python.org/ftp/python/doc/' |
| 28 | |
| 29 | # List of files that shouldn't be included in the build. |
| 30 | unused_files = [ |
| 31 | 'whatsnew/2.0.rst', |
| 32 | 'whatsnew/2.1.rst', |
| 33 | 'whatsnew/2.2.rst', |
| 34 | 'whatsnew/2.3.rst', |
| 35 | 'whatsnew/2.4.rst', |
| 36 | 'whatsnew/2.5.rst', |
| 37 | 'maclib/scrap.rst', |
| 38 | 'library/xmllib.rst', |
| 39 | 'library/xml.etree.rst', |
| 40 | ] |
| 41 | |
| 42 | # If not '', a 'Last updated on:' timestamp is inserted at every page bottom, |
| 43 | # using the given strftime format. |
| 44 | last_updated_format = '%b %d, %Y' |
| 45 | |
| 46 | # If true, SmartyPants will be used to convert quotes and dashes to |
| 47 | # typographically correct entities. |
| 48 | use_smartypants = True |
| 49 | |
| 50 | # If true, '()' will be appended to :func: etc. cross-reference text. |
| 51 | add_function_parentheses = True |
| 52 | |
| 53 | # If true, the current module name will be prepended to all description |
| 54 | # unit titles (such as .. function::). |
| 55 | add_module_names = True |