Mercurial > cpython-lru_cache-weakref
annotate Doc/conf.py @ 78069:a8aa77458e12 3.2
Add c_size_t and c_ssize_t to the ctypes summary table.
| author | Antoine Pitrou <solipsis@pitrou.net> |
|---|---|
| date | Thu, 12 Jul 2012 20:31:50 +0200 |
| parents | 7f123dec2731 |
| children | 57a8a8f5e0bc |
| rev | line source |
|---|---|
|
42604
9e1529bf0442
Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff
changeset
|
1 # |
|
9e1529bf0442
Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff
changeset
|
2 # Python documentation build configuration file |
|
9e1529bf0442
Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff
changeset
|
3 # |
|
44742
14d4104976fc
Merged revisions 59985-60000,60002,60005-60007,60009-60042 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
44329
diff
changeset
|
4 # This file is execfile()d with the current directory set to its containing dir. |
|
14d4104976fc
Merged revisions 59985-60000,60002,60005-60007,60009-60042 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
44329
diff
changeset
|
5 # |
|
42604
9e1529bf0442
Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff
changeset
|
6 # The contents of this file are pickled, so don't put values in the namespace |
|
9e1529bf0442
Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff
changeset
|
7 # that aren't pickleable (module imports are okay, they're removed automatically). |
|
44329
75c6bfd3b1f3
Merged revisions 59512-59540 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
42604
diff
changeset
|
8 |
|
44859
feba5d5cac22
Merged revisions 60151-60159,60161-60168,60170,60172-60173,60175 via svnmerge from
Georg Brandl <georg@python.org>
parents:
44742
diff
changeset
|
9 import sys, os, time |
|
46430
47d9bbe10897
Merged revisions 62260-62261,62266,62271,62277-62279,62289-62290,62293-62298,62302-62306,62308,62311,62313-62315,62319-62321 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
46387
diff
changeset
|
10 sys.path.append(os.path.abspath('tools/sphinxext')) |
|
44859
feba5d5cac22
Merged revisions 60151-60159,60161-60168,60170,60172-60173,60175 via svnmerge from
Georg Brandl <georg@python.org>
parents:
44742
diff
changeset
|
11 |
|
44329
75c6bfd3b1f3
Merged revisions 59512-59540 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
42604
diff
changeset
|
12 # General configuration |
|
75c6bfd3b1f3
Merged revisions 59512-59540 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
42604
diff
changeset
|
13 # --------------------- |
|
42604
9e1529bf0442
Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff
changeset
|
14 |
|
46034
0a485593ae1c
Merged revisions 61724-61725,61731-61735,61737,61739,61741,61743-61744,61753,61761,61765-61767,61769,61773,61776-61778,61780-61783,61788,61793,61796,61807,61813 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
45733
diff
changeset
|
15 extensions = ['sphinx.ext.refcounting', 'sphinx.ext.coverage', |
|
46387
3ce7c796bca1
Merged revisions 62246-62259 via svnmerge from
Martin v. Löwis <martin@v.loewis.de>
parents:
46034
diff
changeset
|
16 'sphinx.ext.doctest', 'pyspecific'] |
|
45733
7f4e6021bc9f
Merged revisions 61330 via svnmerge from
Georg Brandl <georg@python.org>
parents:
45622
diff
changeset
|
17 templates_path = ['tools/sphinxext'] |
|
45026
ebfbaa1051e2
Merged revisions 60364-60378 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
44859
diff
changeset
|
18 |
|
44742
14d4104976fc
Merged revisions 59985-60000,60002,60005-60007,60009-60042 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
44329
diff
changeset
|
19 # General substitutions. |
|
14d4104976fc
Merged revisions 59985-60000,60002,60005-60007,60009-60042 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
44329
diff
changeset
|
20 project = 'Python' |
|
44859
feba5d5cac22
Merged revisions 60151-60159,60161-60168,60170,60172-60173,60175 via svnmerge from
Georg Brandl <georg@python.org>
parents:
44742
diff
changeset
|
21 copyright = '1990-%s, Python Software Foundation' % time.strftime('%Y') |
|
44742
14d4104976fc
Merged revisions 59985-60000,60002,60005-60007,60009-60042 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
44329
diff
changeset
|
22 |
|
42604
9e1529bf0442
Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff
changeset
|
23 # The default replacements for |version| and |release|. |
|
9e1529bf0442
Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff
changeset
|
24 # |
|
9e1529bf0442
Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff
changeset
|
25 # The short X.Y version. |
|
9e1529bf0442
Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff
changeset
|
26 # version = '2.6' |
|
9e1529bf0442
Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff
changeset
|
27 # The full version, including alpha/beta/rc tags. |
|
9e1529bf0442
Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff
changeset
|
28 # release = '2.6a0' |
|
44859
feba5d5cac22
Merged revisions 60151-60159,60161-60168,60170,60172-60173,60175 via svnmerge from
Georg Brandl <georg@python.org>
parents:
44742
diff
changeset
|
29 |
|
feba5d5cac22
Merged revisions 60151-60159,60161-60168,60170,60172-60173,60175 via svnmerge from
Georg Brandl <georg@python.org>
parents:
44742
diff
changeset
|
30 # We look for the Include/patchlevel.h file in the current Python source tree |
|
feba5d5cac22
Merged revisions 60151-60159,60161-60168,60170,60172-60173,60175 via svnmerge from
Georg Brandl <georg@python.org>
parents:
44742
diff
changeset
|
31 # and replace the values accordingly. |
|
feba5d5cac22
Merged revisions 60151-60159,60161-60168,60170,60172-60173,60175 via svnmerge from
Georg Brandl <georg@python.org>
parents:
44742
diff
changeset
|
32 import patchlevel |
|
feba5d5cac22
Merged revisions 60151-60159,60161-60168,60170,60172-60173,60175 via svnmerge from
Georg Brandl <georg@python.org>
parents:
44742
diff
changeset
|
33 version, release = patchlevel.get_version_info() |
|
42604
9e1529bf0442
Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff
changeset
|
34 |
|
9e1529bf0442
Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff
changeset
|
35 # There are two options for replacing |today|: either, you set today to some |
|
9e1529bf0442
Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff
changeset
|
36 # non-false value, then it is used: |
|
9e1529bf0442
Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff
changeset
|
37 today = '' |
|
9e1529bf0442
Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff
changeset
|
38 # Else, today_fmt is used as the format for a strftime call. |
|
9e1529bf0442
Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff
changeset
|
39 today_fmt = '%B %d, %Y' |
|
9e1529bf0442
Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff
changeset
|
40 |
|
9e1529bf0442
Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff
changeset
|
41 # List of files that shouldn't be included in the build. |
|
45278
e67050d62adf
Merged revisions 60481,60485,60489-60492,60494-60496,60498-60499,60501-60503,60505-60506,60508-60509,60523-60524,60532,60543,60545,60547-60548,60552,60554,60556-60559,60561-60562,60569,60571-60572,60574,60576-60583,60585-60586,60589,60591,60594-60595,60597-60598,60600-60601,60606-60612,60615,60617,60619-60621,60623-60625,60627-60629,60631,60633,60635,60647,60650,60652,60654,60656,60658-60659,60664-60666,60668-60670,60672,60676,60678,60680-60683,60685-60686,60688,60690,60692-60694,60697-60706,60708-60712,60714-60724 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
45134
diff
changeset
|
42 unused_docs = [ |
|
e67050d62adf
Merged revisions 60481,60485,60489-60492,60494-60496,60498-60499,60501-60503,60505-60506,60508-60509,60523-60524,60532,60543,60545,60547-60548,60552,60554,60556-60559,60561-60562,60569,60571-60572,60574,60576-60583,60585-60586,60589,60591,60594-60595,60597-60598,60600-60601,60606-60612,60615,60617,60619-60621,60623-60625,60627-60629,60631,60633,60635,60647,60650,60652,60654,60656,60658-60659,60664-60666,60668-60670,60672,60676,60678,60680-60683,60685-60686,60688,60690,60692-60694,60697-60706,60708-60712,60714-60724 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
45134
diff
changeset
|
43 'maclib/scrap', |
|
e67050d62adf
Merged revisions 60481,60485,60489-60492,60494-60496,60498-60499,60501-60503,60505-60506,60508-60509,60523-60524,60532,60543,60545,60547-60548,60552,60554,60556-60559,60561-60562,60569,60571-60572,60574,60576-60583,60585-60586,60589,60591,60594-60595,60597-60598,60600-60601,60606-60612,60615,60617,60619-60621,60623-60625,60627-60629,60631,60633,60635,60647,60650,60652,60654,60656,60658-60659,60664-60666,60668-60670,60672,60676,60678,60680-60683,60685-60686,60688,60690,60692-60694,60697-60706,60708-60712,60714-60724 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
45134
diff
changeset
|
44 'library/xmllib', |
|
e67050d62adf
Merged revisions 60481,60485,60489-60492,60494-60496,60498-60499,60501-60503,60505-60506,60508-60509,60523-60524,60532,60543,60545,60547-60548,60552,60554,60556-60559,60561-60562,60569,60571-60572,60574,60576-60583,60585-60586,60589,60591,60594-60595,60597-60598,60600-60601,60606-60612,60615,60617,60619-60621,60623-60625,60627-60629,60631,60633,60635,60647,60650,60652,60654,60656,60658-60659,60664-60666,60668-60670,60672,60676,60678,60680-60683,60685-60686,60688,60690,60692-60694,60697-60706,60708-60712,60714-60724 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
45134
diff
changeset
|
45 'library/xml.etree', |
|
42604
9e1529bf0442
Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff
changeset
|
46 ] |
|
9e1529bf0442
Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff
changeset
|
47 |
|
54501
ced380b40004
Merged revisions 72506,72525-72526,72551,72558,72616,72654-72655,72689,72745,72750,72802,72812,72822,72824,72826-72827,72833,72876,72890,72923,72946,73026,73042,73045,73047,73065,73068-73069 via svnmerge from
Benjamin Peterson <benjamin@python.org>
parents:
49772
diff
changeset
|
48 # Ignore .rst in Sphinx its self. |
|
ced380b40004
Merged revisions 72506,72525-72526,72551,72558,72616,72654-72655,72689,72745,72750,72802,72812,72822,72824,72826-72827,72833,72876,72890,72923,72946,73026,73042,73045,73047,73065,73068-73069 via svnmerge from
Benjamin Peterson <benjamin@python.org>
parents:
49772
diff
changeset
|
49 exclude_trees = ['tools/sphinx'] |
|
ced380b40004
Merged revisions 72506,72525-72526,72551,72558,72616,72654-72655,72689,72745,72750,72802,72812,72822,72824,72826-72827,72833,72876,72890,72923,72946,73026,73042,73045,73047,73065,73068-73069 via svnmerge from
Benjamin Peterson <benjamin@python.org>
parents:
49772
diff
changeset
|
50 |
|
44742
14d4104976fc
Merged revisions 59985-60000,60002,60005-60007,60009-60042 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
44329
diff
changeset
|
51 # Relative filename of the reference count data file. |
|
14d4104976fc
Merged revisions 59985-60000,60002,60005-60007,60009-60042 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
44329
diff
changeset
|
52 refcount_file = 'data/refcounts.dat' |
|
14d4104976fc
Merged revisions 59985-60000,60002,60005-60007,60009-60042 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
44329
diff
changeset
|
53 |
|
42604
9e1529bf0442
Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff
changeset
|
54 # If true, '()' will be appended to :func: etc. cross-reference text. |
|
9e1529bf0442
Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff
changeset
|
55 add_function_parentheses = True |
|
9e1529bf0442
Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff
changeset
|
56 |
|
9e1529bf0442
Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff
changeset
|
57 # If true, the current module name will be prepended to all description |
|
9e1529bf0442
Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff
changeset
|
58 # unit titles (such as .. function::). |
|
9e1529bf0442
Move the 3k reST doc tree in place.
Georg Brandl <georg@python.org>
parents:
diff
changeset
|
59 add_module_names = True |
|
44329
75c6bfd3b1f3
Merged revisions 59512-59540 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
42604
diff
changeset
|
60 |
|
49113
139f6baef6c2
Highlight snippets as Python 3.
Georg Brandl <georg@python.org>
parents:
48321
diff
changeset
|
61 # By default, highlight as Python 3. |
|
139f6baef6c2
Highlight snippets as Python 3.
Georg Brandl <georg@python.org>
parents:
48321
diff
changeset
|
62 highlight_language = 'python3' |
|
139f6baef6c2
Highlight snippets as Python 3.
Georg Brandl <georg@python.org>
parents:
48321
diff
changeset
|
63 |
|
44329
75c6bfd3b1f3
Merged revisions 59512-59540 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
42604
diff
changeset
|
64 |
|
75c6bfd3b1f3
Merged revisions 59512-59540 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
42604
diff
changeset
|
65 # Options for HTML output |
|
75c6bfd3b1f3
Merged revisions 59512-59540 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
42604
diff
changeset
|
66 # ----------------------- |
|
75c6bfd3b1f3
Merged revisions 59512-59540 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
42604
diff
changeset
|
67 |
|
75932
ca0230c21c79
Switch to new "lighter" doc design.
Georg Brandl <georg@python.org>
parents:
74455
diff
changeset
|
68 html_theme = 'pydoctheme' |
|
ca0230c21c79
Switch to new "lighter" doc design.
Georg Brandl <georg@python.org>
parents:
74455
diff
changeset
|
69 html_theme_path = ['tools/sphinxext'] |
|
63317
ad98b525b587
#3143: enable "collapsible sidebar" feature of new Sphinx version.
Georg Brandl <georg@python.org>
parents:
63243
diff
changeset
|
70 html_theme_options = {'collapsiblesidebar': True} |
|
ad98b525b587
#3143: enable "collapsible sidebar" feature of new Sphinx version.
Georg Brandl <georg@python.org>
parents:
63243
diff
changeset
|
71 |
|
75932
ca0230c21c79
Switch to new "lighter" doc design.
Georg Brandl <georg@python.org>
parents:
74455
diff
changeset
|
72 html_short_title = '%s Documentation' % release |
|
ca0230c21c79
Switch to new "lighter" doc design.
Georg Brandl <georg@python.org>
parents:
74455
diff
changeset
|
73 |
|
44329
75c6bfd3b1f3
Merged revisions 59512-59540 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
42604
diff
changeset
|
74 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom, |
|
75c6bfd3b1f3
Merged revisions 59512-59540 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
42604
diff
changeset
|
75 # using the given strftime format. |
|
75c6bfd3b1f3
Merged revisions 59512-59540 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
42604
diff
changeset
|
76 html_last_updated_fmt = '%b %d, %Y' |
|
75c6bfd3b1f3
Merged revisions 59512-59540 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
42604
diff
changeset
|
77 |
|
75c6bfd3b1f3
Merged revisions 59512-59540 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
42604
diff
changeset
|
78 # If true, SmartyPants will be used to convert quotes and dashes to |
|
75c6bfd3b1f3
Merged revisions 59512-59540 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
42604
diff
changeset
|
79 # typographically correct entities. |
|
75c6bfd3b1f3
Merged revisions 59512-59540 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
42604
diff
changeset
|
80 html_use_smartypants = True |
|
75c6bfd3b1f3
Merged revisions 59512-59540 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
42604
diff
changeset
|
81 |
|
44742
14d4104976fc
Merged revisions 59985-60000,60002,60005-60007,60009-60042 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
44329
diff
changeset
|
82 # Custom sidebar templates, filenames relative to this file. |
|
14d4104976fc
Merged revisions 59985-60000,60002,60005-60007,60009-60042 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
44329
diff
changeset
|
83 html_sidebars = { |
|
45733
7f4e6021bc9f
Merged revisions 61330 via svnmerge from
Georg Brandl <georg@python.org>
parents:
45622
diff
changeset
|
84 'index': 'indexsidebar.html', |
|
44742
14d4104976fc
Merged revisions 59985-60000,60002,60005-60007,60009-60042 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
44329
diff
changeset
|
85 } |
|
14d4104976fc
Merged revisions 59985-60000,60002,60005-60007,60009-60042 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
44329
diff
changeset
|
86 |
|
14d4104976fc
Merged revisions 59985-60000,60002,60005-60007,60009-60042 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
44329
diff
changeset
|
87 # Additional templates that should be rendered to pages. |
|
14d4104976fc
Merged revisions 59985-60000,60002,60005-60007,60009-60042 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
44329
diff
changeset
|
88 html_additional_pages = { |
|
45733
7f4e6021bc9f
Merged revisions 61330 via svnmerge from
Georg Brandl <georg@python.org>
parents:
45622
diff
changeset
|
89 'download': 'download.html', |
|
46505
63965327b3ef
Merged revisions 62386-62387,62389-62393,62396,62400-62402,62407,62409-62410,62412-62414,62418-62419 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
46430
diff
changeset
|
90 'index': 'indexcontent.html', |
|
44742
14d4104976fc
Merged revisions 59985-60000,60002,60005-60007,60009-60042 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
44329
diff
changeset
|
91 } |
|
14d4104976fc
Merged revisions 59985-60000,60002,60005-60007,60009-60042 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
44329
diff
changeset
|
92 |
|
46648
5bb94065b079
Merge OpenSearch-related changes.
Georg Brandl <georg@python.org>
parents:
46505
diff
changeset
|
93 # Output an OpenSearch description file. |
|
76153
7f123dec2731
Closes #14511: fix wrong opensearch link for 3.2 docs.
Georg Brandl <georg@python.org>
parents:
75932
diff
changeset
|
94 html_use_opensearch = 'http://docs.python.org/3.2' |
|
46648
5bb94065b079
Merge OpenSearch-related changes.
Georg Brandl <georg@python.org>
parents:
46505
diff
changeset
|
95 |
|
5bb94065b079
Merge OpenSearch-related changes.
Georg Brandl <georg@python.org>
parents:
46505
diff
changeset
|
96 # Additional static files. |
|
5bb94065b079
Merge OpenSearch-related changes.
Georg Brandl <georg@python.org>
parents:
46505
diff
changeset
|
97 html_static_path = ['tools/sphinxext/static'] |
|
5bb94065b079
Merge OpenSearch-related changes.
Georg Brandl <georg@python.org>
parents:
46505
diff
changeset
|
98 |
|
44742
14d4104976fc
Merged revisions 59985-60000,60002,60005-60007,60009-60042 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
44329
diff
changeset
|
99 # Output file base name for HTML help builder. |
|
45622
a31b650515cb
Merged revisions 61143-61144,61146-61147,61150-61151,61157,61165-61168,61170-61173,61176-61177,61183 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
45534
diff
changeset
|
100 htmlhelp_basename = 'python' + release.replace('.', '') |
|
44742
14d4104976fc
Merged revisions 59985-60000,60002,60005-60007,60009-60042 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
44329
diff
changeset
|
101 |
|
48321
f6726f32ef70
Merged revisions 64119,64147,64150,64165,64219-64221,64229-64230,64233,64235,64253,64278,64280,64301,64303,64320,64328,64338-64339 via svnmerge from
Amaury Forgeot d'Arc <amauryfa@gmail.com>
parents:
46648
diff
changeset
|
102 # Split the index |
|
f6726f32ef70
Merged revisions 64119,64147,64150,64165,64219-64221,64229-64230,64233,64235,64253,64278,64280,64301,64303,64320,64328,64338-64339 via svnmerge from
Amaury Forgeot d'Arc <amauryfa@gmail.com>
parents:
46648
diff
changeset
|
103 html_split_index = True |
|
f6726f32ef70
Merged revisions 64119,64147,64150,64165,64219-64221,64229-64230,64233,64235,64253,64278,64280,64301,64303,64320,64328,64338-64339 via svnmerge from
Amaury Forgeot d'Arc <amauryfa@gmail.com>
parents:
46648
diff
changeset
|
104 |
|
44329
75c6bfd3b1f3
Merged revisions 59512-59540 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
42604
diff
changeset
|
105 |
|
75c6bfd3b1f3
Merged revisions 59512-59540 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
42604
diff
changeset
|
106 # Options for LaTeX output |
|
75c6bfd3b1f3
Merged revisions 59512-59540 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
42604
diff
changeset
|
107 # ------------------------ |
|
75c6bfd3b1f3
Merged revisions 59512-59540 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
42604
diff
changeset
|
108 |
|
44742
14d4104976fc
Merged revisions 59985-60000,60002,60005-60007,60009-60042 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
44329
diff
changeset
|
109 # The paper size ('letter' or 'a4'). |
|
14d4104976fc
Merged revisions 59985-60000,60002,60005-60007,60009-60042 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
44329
diff
changeset
|
110 latex_paper_size = 'a4' |
|
14d4104976fc
Merged revisions 59985-60000,60002,60005-60007,60009-60042 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
44329
diff
changeset
|
111 |
|
14d4104976fc
Merged revisions 59985-60000,60002,60005-60007,60009-60042 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
44329
diff
changeset
|
112 # The font size ('10pt', '11pt' or '12pt'). |
|
14d4104976fc
Merged revisions 59985-60000,60002,60005-60007,60009-60042 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
44329
diff
changeset
|
113 latex_font_size = '10pt' |
|
44329
75c6bfd3b1f3
Merged revisions 59512-59540 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
42604
diff
changeset
|
114 |
|
44742
14d4104976fc
Merged revisions 59985-60000,60002,60005-60007,60009-60042 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
44329
diff
changeset
|
115 # Grouping the document tree into LaTeX files. List of tuples |
|
14d4104976fc
Merged revisions 59985-60000,60002,60005-60007,60009-60042 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
44329
diff
changeset
|
116 # (source start file, target name, title, author, document class [howto/manual]). |
|
14d4104976fc
Merged revisions 59985-60000,60002,60005-60007,60009-60042 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
44329
diff
changeset
|
117 _stdauthor = r'Guido van Rossum\\Fred L. Drake, Jr., editor' |
|
14d4104976fc
Merged revisions 59985-60000,60002,60005-60007,60009-60042 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
44329
diff
changeset
|
118 latex_documents = [ |
|
45134
bdcf40d1b38e
Merged revisions 60481,60485,60489-60520,60523-60527,60530-60533,60535-60538,60540-60551 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
45026
diff
changeset
|
119 ('c-api/index', 'c-api.tex', |
|
44742
14d4104976fc
Merged revisions 59985-60000,60002,60005-60007,60009-60042 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
44329
diff
changeset
|
120 'The Python/C API', _stdauthor, 'manual'), |
|
45134
bdcf40d1b38e
Merged revisions 60481,60485,60489-60520,60523-60527,60530-60533,60535-60538,60540-60551 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
45026
diff
changeset
|
121 ('distutils/index', 'distutils.tex', |
|
44742
14d4104976fc
Merged revisions 59985-60000,60002,60005-60007,60009-60042 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
44329
diff
changeset
|
122 'Distributing Python Modules', _stdauthor, 'manual'), |
|
45134
bdcf40d1b38e
Merged revisions 60481,60485,60489-60520,60523-60527,60530-60533,60535-60538,60540-60551 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
45026
diff
changeset
|
123 ('extending/index', 'extending.tex', |
|
44742
14d4104976fc
Merged revisions 59985-60000,60002,60005-60007,60009-60042 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
44329
diff
changeset
|
124 'Extending and Embedding Python', _stdauthor, 'manual'), |
|
45134
bdcf40d1b38e
Merged revisions 60481,60485,60489-60520,60523-60527,60530-60533,60535-60538,60540-60551 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
45026
diff
changeset
|
125 ('install/index', 'install.tex', |
|
44742
14d4104976fc
Merged revisions 59985-60000,60002,60005-60007,60009-60042 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
44329
diff
changeset
|
126 'Installing Python Modules', _stdauthor, 'manual'), |
|
45134
bdcf40d1b38e
Merged revisions 60481,60485,60489-60520,60523-60527,60530-60533,60535-60538,60540-60551 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
45026
diff
changeset
|
127 ('library/index', 'library.tex', |
|
44742
14d4104976fc
Merged revisions 59985-60000,60002,60005-60007,60009-60042 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
44329
diff
changeset
|
128 'The Python Library Reference', _stdauthor, 'manual'), |
|
45134
bdcf40d1b38e
Merged revisions 60481,60485,60489-60520,60523-60527,60530-60533,60535-60538,60540-60551 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
45026
diff
changeset
|
129 ('reference/index', 'reference.tex', |
|
44742
14d4104976fc
Merged revisions 59985-60000,60002,60005-60007,60009-60042 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
44329
diff
changeset
|
130 'The Python Language Reference', _stdauthor, 'manual'), |
|
45134
bdcf40d1b38e
Merged revisions 60481,60485,60489-60520,60523-60527,60530-60533,60535-60538,60540-60551 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
45026
diff
changeset
|
131 ('tutorial/index', 'tutorial.tex', |
|
44742
14d4104976fc
Merged revisions 59985-60000,60002,60005-60007,60009-60042 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
44329
diff
changeset
|
132 'Python Tutorial', _stdauthor, 'manual'), |
|
45134
bdcf40d1b38e
Merged revisions 60481,60485,60489-60520,60523-60527,60530-60533,60535-60538,60540-60551 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
45026
diff
changeset
|
133 ('using/index', 'using.tex', |
|
65119
f00440af9413
Merged revisions 84249,84264,84326-84327,84407,84476,84480-84482,84484,84530-84531,84553,84619,84684,84915-84916 via svnmerge from
Georg Brandl <georg@python.org>
parents:
64371
diff
changeset
|
134 'Python Setup and Usage', _stdauthor, 'manual'), |
|
66478
7281937b2d65
Merged revisions 86134,86315-86316,86390,86424-86425,86428,86550,86561-86562,86564-86565,86705,86708,86713 via svnmerge from
Georg Brandl <georg@python.org>
parents:
65119
diff
changeset
|
135 ('faq/index', 'faq.tex', |
|
7281937b2d65
Merged revisions 86134,86315-86316,86390,86424-86425,86428,86550,86561-86562,86564-86565,86705,86708,86713 via svnmerge from
Georg Brandl <georg@python.org>
parents:
65119
diff
changeset
|
136 'Python Frequently Asked Questions', _stdauthor, 'manual'), |
|
45134
bdcf40d1b38e
Merged revisions 60481,60485,60489-60520,60523-60527,60530-60533,60535-60538,60540-60551 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
45026
diff
changeset
|
137 ('whatsnew/' + version, 'whatsnew.tex', |
|
44742
14d4104976fc
Merged revisions 59985-60000,60002,60005-60007,60009-60042 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
44329
diff
changeset
|
138 'What\'s New in Python', 'A. M. Kuchling', 'howto'), |
|
14d4104976fc
Merged revisions 59985-60000,60002,60005-60007,60009-60042 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
44329
diff
changeset
|
139 ] |
|
14d4104976fc
Merged revisions 59985-60000,60002,60005-60007,60009-60042 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
44329
diff
changeset
|
140 # Collect all HOWTOs individually |
|
45134
bdcf40d1b38e
Merged revisions 60481,60485,60489-60520,60523-60527,60530-60533,60535-60538,60540-60551 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
45026
diff
changeset
|
141 latex_documents.extend(('howto/' + fn[:-4], 'howto-' + fn[:-4] + '.tex', |
|
49734
b0fcb17f7efa
Merged revisions 67154,67157-67159,67175-67176,67189,67224-67227,67234 via svnmerge from
Benjamin Peterson <benjamin@python.org>
parents:
49493
diff
changeset
|
142 '', _stdauthor, 'howto') |
|
44742
14d4104976fc
Merged revisions 59985-60000,60002,60005-60007,60009-60042 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
44329
diff
changeset
|
143 for fn in os.listdir('howto') |
|
14d4104976fc
Merged revisions 59985-60000,60002,60005-60007,60009-60042 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
44329
diff
changeset
|
144 if fn.endswith('.rst') and fn != 'index.rst') |
|
14d4104976fc
Merged revisions 59985-60000,60002,60005-60007,60009-60042 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
44329
diff
changeset
|
145 |
|
14d4104976fc
Merged revisions 59985-60000,60002,60005-60007,60009-60042 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
44329
diff
changeset
|
146 # Additional stuff for the LaTeX preamble. |
|
14d4104976fc
Merged revisions 59985-60000,60002,60005-60007,60009-60042 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
44329
diff
changeset
|
147 latex_preamble = r''' |
|
14d4104976fc
Merged revisions 59985-60000,60002,60005-60007,60009-60042 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
44329
diff
changeset
|
148 \authoraddress{ |
|
14d4104976fc
Merged revisions 59985-60000,60002,60005-60007,60009-60042 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
44329
diff
changeset
|
149 \strong{Python Software Foundation}\\ |
|
14d4104976fc
Merged revisions 59985-60000,60002,60005-60007,60009-60042 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
44329
diff
changeset
|
150 Email: \email{docs@python.org} |
|
14d4104976fc
Merged revisions 59985-60000,60002,60005-60007,60009-60042 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
44329
diff
changeset
|
151 } |
|
49772
088fdadf9609
Merged revisions 67243,67245,67277-67278,67289 via svnmerge from
Benjamin Peterson <benjamin@python.org>
parents:
49734
diff
changeset
|
152 \let\Verbatim=\OriginalVerbatim |
|
088fdadf9609
Merged revisions 67243,67245,67277-67278,67289 via svnmerge from
Benjamin Peterson <benjamin@python.org>
parents:
49734
diff
changeset
|
153 \let\endVerbatim=\endOriginalVerbatim |
|
44742
14d4104976fc
Merged revisions 59985-60000,60002,60005-60007,60009-60042 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
44329
diff
changeset
|
154 ''' |
|
14d4104976fc
Merged revisions 59985-60000,60002,60005-60007,60009-60042 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
44329
diff
changeset
|
155 |
|
14d4104976fc
Merged revisions 59985-60000,60002,60005-60007,60009-60042 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
44329
diff
changeset
|
156 # Documents to append as an appendix to all manuals. |
|
45134
bdcf40d1b38e
Merged revisions 60481,60485,60489-60520,60523-60527,60530-60533,60535-60538,60540-60551 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
45026
diff
changeset
|
157 latex_appendices = ['glossary', 'about', 'license', 'copyright'] |
|
45495
48488fa50729
Merged revisions 61003-61033 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
45278
diff
changeset
|
158 |
|
55913
3fb1c1fbe26c
Merged revisions 74745 via svnmerge from
Benjamin Peterson <benjamin@python.org>
parents:
54501
diff
changeset
|
159 # Get LaTeX to handle Unicode correctly |
| 63243 | 160 latex_elements = {'inputenc': r'\usepackage[utf8x]{inputenc}', 'utf8extra': ''} |
|
55913
3fb1c1fbe26c
Merged revisions 74745 via svnmerge from
Benjamin Peterson <benjamin@python.org>
parents:
54501
diff
changeset
|
161 |
|
45495
48488fa50729
Merged revisions 61003-61033 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
45278
diff
changeset
|
162 # Options for the coverage checker |
|
48488fa50729
Merged revisions 61003-61033 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
45278
diff
changeset
|
163 # -------------------------------- |
|
48488fa50729
Merged revisions 61003-61033 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
45278
diff
changeset
|
164 |
|
48488fa50729
Merged revisions 61003-61033 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
45278
diff
changeset
|
165 # The coverage checker will ignore all modules/functions/classes whose names |
|
48488fa50729
Merged revisions 61003-61033 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
45278
diff
changeset
|
166 # match any of the following regexes (using re.match). |
|
48488fa50729
Merged revisions 61003-61033 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
45278
diff
changeset
|
167 coverage_ignore_modules = [ |
|
48488fa50729
Merged revisions 61003-61033 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
45278
diff
changeset
|
168 r'[T|t][k|K]', |
|
48488fa50729
Merged revisions 61003-61033 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
45278
diff
changeset
|
169 r'Tix', |
|
48488fa50729
Merged revisions 61003-61033 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
45278
diff
changeset
|
170 r'distutils.*', |
|
48488fa50729
Merged revisions 61003-61033 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
45278
diff
changeset
|
171 ] |
|
48488fa50729
Merged revisions 61003-61033 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
45278
diff
changeset
|
172 |
|
48488fa50729
Merged revisions 61003-61033 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
45278
diff
changeset
|
173 coverage_ignore_functions = [ |
|
48488fa50729
Merged revisions 61003-61033 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
45278
diff
changeset
|
174 'test($|_)', |
|
48488fa50729
Merged revisions 61003-61033 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
45278
diff
changeset
|
175 ] |
|
48488fa50729
Merged revisions 61003-61033 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
45278
diff
changeset
|
176 |
|
48488fa50729
Merged revisions 61003-61033 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
45278
diff
changeset
|
177 coverage_ignore_classes = [ |
|
48488fa50729
Merged revisions 61003-61033 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
45278
diff
changeset
|
178 ] |
|
48488fa50729
Merged revisions 61003-61033 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
45278
diff
changeset
|
179 |
|
48488fa50729
Merged revisions 61003-61033 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
45278
diff
changeset
|
180 # Glob patterns for C source files for C API coverage, relative to this directory. |
|
48488fa50729
Merged revisions 61003-61033 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
45278
diff
changeset
|
181 coverage_c_path = [ |
|
48488fa50729
Merged revisions 61003-61033 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
45278
diff
changeset
|
182 '../Include/*.h', |
|
48488fa50729
Merged revisions 61003-61033 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
45278
diff
changeset
|
183 ] |
|
48488fa50729
Merged revisions 61003-61033 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
45278
diff
changeset
|
184 |
|
48488fa50729
Merged revisions 61003-61033 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
45278
diff
changeset
|
185 # Regexes to find C items in the source files. |
|
48488fa50729
Merged revisions 61003-61033 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
45278
diff
changeset
|
186 coverage_c_regexes = { |
|
48488fa50729
Merged revisions 61003-61033 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
45278
diff
changeset
|
187 'cfunction': (r'^PyAPI_FUNC\(.*\)\s+([^_][\w_]+)'), |
|
48488fa50729
Merged revisions 61003-61033 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
45278
diff
changeset
|
188 'data': (r'^PyAPI_DATA\(.*\)\s+([^_][\w_]+)'), |
|
48488fa50729
Merged revisions 61003-61033 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
45278
diff
changeset
|
189 'macro': (r'^#define ([^_][\w_]+)\(.*\)[\s|\\]'), |
|
48488fa50729
Merged revisions 61003-61033 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
45278
diff
changeset
|
190 } |
|
48488fa50729
Merged revisions 61003-61033 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
45278
diff
changeset
|
191 |
|
48488fa50729
Merged revisions 61003-61033 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
45278
diff
changeset
|
192 # The coverage checker will ignore all C items whose names match these regexes |
|
48488fa50729
Merged revisions 61003-61033 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
45278
diff
changeset
|
193 # (using re.match) -- the keys must be the same as in coverage_c_regexes. |
|
48488fa50729
Merged revisions 61003-61033 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
45278
diff
changeset
|
194 coverage_ignore_c_items = { |
|
48488fa50729
Merged revisions 61003-61033 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
45278
diff
changeset
|
195 # 'cfunction': [...] |
|
48488fa50729
Merged revisions 61003-61033 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
45278
diff
changeset
|
196 } |