Show More
@@ -1,121 +1,138 b'' | |||||
1 | # Makefile for Sphinx documentation |
|
1 | # Makefile for Sphinx documentation | |
2 | # |
|
2 | # | |
3 |
|
3 | |||
4 | # You can set these variables from the command line. |
|
4 | # You can set these variables from the command line. | |
5 | SPHINXOPTS = |
|
5 | SPHINXOPTS = | |
6 | SPHINXBUILD = sphinx-build |
|
6 | SPHINXBUILD = sphinx-build | |
7 | PAPER = |
|
7 | PAPER = | |
8 | SRCDIR = source |
|
8 | SRCDIR = source | |
9 | BUILDDIR = build |
|
9 | BUILDDIR = build | |
10 |
|
10 | |||
11 | # Internal variables. |
|
11 | # Internal variables. | |
12 | PAPEROPT_a4 = -D latex_paper_size=a4 |
|
12 | PAPEROPT_a4 = -D latex_paper_size=a4 | |
13 | PAPEROPT_letter = -D latex_paper_size=letter |
|
13 | PAPEROPT_letter = -D latex_paper_size=letter | |
14 | ALLSPHINXOPTS = -d build/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) $(SRCDIR) |
|
14 | ALLSPHINXOPTS = -d build/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) $(SRCDIR) | |
15 |
|
15 | |||
16 | .PHONY: help clean html web pickle htmlhelp latex changes linkcheck api |
|
16 | .PHONY: help clean html web pickle htmlhelp latex changes linkcheck api | |
17 |
|
17 | |||
18 | default: html |
|
18 | default: html | |
19 |
|
19 | |||
20 | help: |
|
20 | help: | |
21 | @echo "Please use \`make <target>' where <target> is one of" |
|
21 | @echo "Please use \`make <target>' where <target> is one of" | |
22 | @echo " html to make standalone HTML files" |
|
22 | @echo " html to make standalone HTML files" | |
23 | @echo " pickle to make pickle files (usable by e.g. sphinx-web)" |
|
23 | @echo " pickle to make pickle files (usable by e.g. sphinx-web)" | |
24 | @echo " htmlhelp to make HTML files and a HTML help project" |
|
24 | @echo " htmlhelp to make HTML files and a HTML help project" | |
25 | @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter" |
|
25 | @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter" | |
|
26 | @echo " texinfo to make Texinfo files" | |||
|
27 | @echo " info to make Texinfo files and run them through makeinfo" | |||
26 | @echo " changes to make an overview over all changed/added/deprecated items" |
|
28 | @echo " changes to make an overview over all changed/added/deprecated items" | |
27 | @echo " linkcheck to check all external links for integrity" |
|
29 | @echo " linkcheck to check all external links for integrity" | |
28 | @echo |
|
30 | @echo | |
29 | @echo "Compound utility targets:" |
|
31 | @echo "Compound utility targets:" | |
30 | @echo "pdf latex and then runs the PDF generation" |
|
32 | @echo "pdf latex and then runs the PDF generation" | |
31 | @echo "all html and pdf" |
|
33 | @echo "all html and pdf" | |
32 | @echo "dist all, and then puts the results in dist/" |
|
34 | @echo "dist all, and then puts the results in dist/" | |
33 | @echo "gitwash-update update git workflow from source repo" |
|
35 | @echo "gitwash-update update git workflow from source repo" | |
34 |
|
36 | |||
35 | clean: |
|
37 | clean: | |
36 | -rm -rf build/* dist/* $(SRCDIR)/api/generated |
|
38 | -rm -rf build/* dist/* $(SRCDIR)/api/generated | |
37 |
|
39 | |||
38 | pdf: latex |
|
40 | pdf: latex | |
39 | cd build/latex && make all-pdf |
|
41 | cd build/latex && make all-pdf | |
40 |
|
42 | |||
41 | all: html pdf |
|
43 | all: html pdf | |
42 |
|
44 | |||
43 | # For final distribution, only build HTML (our pdf is now so large as to be |
|
45 | # For final distribution, only build HTML (our pdf is now so large as to be | |
44 | # unusable, takes forever to build and just bloats the downloads). We leave |
|
46 | # unusable, takes forever to build and just bloats the downloads). We leave | |
45 | # them hardlinked at the top-level so users find them easily, though the |
|
47 | # them hardlinked at the top-level so users find them easily, though the | |
46 | # original build/html dir is left in-place (useful to reload builds while |
|
48 | # original build/html dir is left in-place (useful to reload builds while | |
47 | # testing). |
|
49 | # testing). | |
48 | dist: html |
|
50 | dist: html | |
49 | rm -rf html |
|
51 | rm -rf html | |
50 | cp -al build/html . |
|
52 | cp -al build/html . | |
51 | @echo "Build finished. Final docs are in html/" |
|
53 | @echo "Build finished. Final docs are in html/" | |
52 |
|
54 | |||
53 | html: api |
|
55 | html: api | |
54 | mkdir -p build/html build/doctrees |
|
56 | mkdir -p build/html build/doctrees | |
55 | $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) build/html |
|
57 | $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) build/html | |
56 | @echo |
|
58 | @echo | |
57 | @echo "Build finished. The HTML pages are in build/html." |
|
59 | @echo "Build finished. The HTML pages are in build/html." | |
58 |
|
60 | |||
59 | api: source/api/generated/gen.txt |
|
61 | api: source/api/generated/gen.txt | |
60 |
|
62 | |||
61 | source/api/generated/gen.txt: |
|
63 | source/api/generated/gen.txt: | |
62 | python autogen_api.py |
|
64 | python autogen_api.py | |
63 | @echo "Build API docs finished." |
|
65 | @echo "Build API docs finished." | |
64 |
|
66 | |||
65 | pickle: |
|
67 | pickle: | |
66 | mkdir -p build/pickle build/doctrees |
|
68 | mkdir -p build/pickle build/doctrees | |
67 | $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) build/pickle |
|
69 | $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) build/pickle | |
68 | @echo |
|
70 | @echo | |
69 | @echo "Build finished; now you can process the pickle files or run" |
|
71 | @echo "Build finished; now you can process the pickle files or run" | |
70 | @echo " sphinx-web build/pickle" |
|
72 | @echo " sphinx-web build/pickle" | |
71 | @echo "to start the sphinx-web server." |
|
73 | @echo "to start the sphinx-web server." | |
72 |
|
74 | |||
73 | web: pickle |
|
75 | web: pickle | |
74 |
|
76 | |||
75 | htmlhelp: |
|
77 | htmlhelp: | |
76 | mkdir -p build/htmlhelp build/doctrees |
|
78 | mkdir -p build/htmlhelp build/doctrees | |
77 | $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) build/htmlhelp |
|
79 | $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) build/htmlhelp | |
78 | @echo |
|
80 | @echo | |
79 | @echo "Build finished; now you can run HTML Help Workshop with the" \ |
|
81 | @echo "Build finished; now you can run HTML Help Workshop with the" \ | |
80 | ".hhp project file in build/htmlhelp." |
|
82 | ".hhp project file in build/htmlhelp." | |
81 |
|
83 | |||
82 | qthelp: |
|
84 | qthelp: | |
83 | mkdir -p build/qthelp |
|
85 | mkdir -p build/qthelp | |
84 | $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) build/qthelp |
|
86 | $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) build/qthelp | |
85 | @echo |
|
87 | @echo | |
86 | @echo "Build finished; now you can run "qcollectiongenerator" with the" \ |
|
88 | @echo "Build finished; now you can run "qcollectiongenerator" with the" \ | |
87 | ".qhcp project file in $(BUILDDIR)/qthelp, like this:" |
|
89 | ".qhcp project file in $(BUILDDIR)/qthelp, like this:" | |
88 | @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/IPython.qhcp" |
|
90 | @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/IPython.qhcp" | |
89 | @echo "To view the help file:" |
|
91 | @echo "To view the help file:" | |
90 | @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/IPython.qhc" |
|
92 | @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/IPython.qhc" | |
91 |
|
93 | |||
92 | latex: api |
|
94 | latex: api | |
93 | mkdir -p build/latex build/doctrees |
|
95 | mkdir -p build/latex build/doctrees | |
94 | $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) build/latex |
|
96 | $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) build/latex | |
95 | @echo |
|
97 | @echo | |
96 | @echo "Build finished; the LaTeX files are in build/latex." |
|
98 | @echo "Build finished; the LaTeX files are in build/latex." | |
97 | @echo "Run \`make all-pdf' or \`make all-ps' in that directory to" \ |
|
99 | @echo "Run \`make all-pdf' or \`make all-ps' in that directory to" \ | |
98 | "run these through (pdf)latex." |
|
100 | "run these through (pdf)latex." | |
99 |
|
101 | |||
100 | changes: |
|
102 | changes: | |
101 | mkdir -p build/changes build/doctrees |
|
103 | mkdir -p build/changes build/doctrees | |
102 | $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) build/changes |
|
104 | $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) build/changes | |
103 | @echo |
|
105 | @echo | |
104 | @echo "The overview file is in build/changes." |
|
106 | @echo "The overview file is in build/changes." | |
105 |
|
107 | |||
106 | linkcheck: |
|
108 | linkcheck: | |
107 | mkdir -p build/linkcheck build/doctrees |
|
109 | mkdir -p build/linkcheck build/doctrees | |
108 | $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) build/linkcheck |
|
110 | $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) build/linkcheck | |
109 | @echo |
|
111 | @echo | |
110 | @echo "Link check complete; look for any errors in the above output " \ |
|
112 | @echo "Link check complete; look for any errors in the above output " \ | |
111 | "or in build/linkcheck/output.txt." |
|
113 | "or in build/linkcheck/output.txt." | |
112 |
|
114 | |||
113 | gitwash-update: |
|
115 | gitwash-update: | |
114 | python ../tools/gitwash_dumper.py source/development ipython |
|
116 | python ../tools/gitwash_dumper.py source/development ipython | |
115 | cd source/development/gitwash && rename 's/.rst/.txt/' *.rst |
|
117 | cd source/development/gitwash && rename 's/.rst/.txt/' *.rst | |
116 |
|
118 | |||
117 | nightly: dist |
|
119 | nightly: dist | |
118 | rsync -avH --delete dist/ ipython:www/doc/nightly |
|
120 | rsync -avH --delete dist/ ipython:www/doc/nightly | |
119 |
|
121 | |||
120 | gh-pages: clean html |
|
122 | gh-pages: clean html | |
121 | python gh-pages.py |
|
123 | python gh-pages.py | |
|
124 | ||||
|
125 | texinfo: | |||
|
126 | mkdir -p $(BUILDDIR)/texinfo | |||
|
127 | $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo | |||
|
128 | @echo | |||
|
129 | @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo." | |||
|
130 | @echo "Run \`make' in that directory to run these through makeinfo" \ | |||
|
131 | "(use \`make info' here to do that automatically)." | |||
|
132 | ||||
|
133 | info: | |||
|
134 | mkdir -p $(BUILDDIR)/texinfo | |||
|
135 | $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo | |||
|
136 | @echo "Running Texinfo files through makeinfo..." | |||
|
137 | make -C $(BUILDDIR)/texinfo info | |||
|
138 | @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo." |
@@ -1,215 +1,228 b'' | |||||
1 | # -*- coding: utf-8 -*- |
|
1 | # -*- coding: utf-8 -*- | |
2 | # |
|
2 | # | |
3 | # IPython documentation build configuration file. |
|
3 | # IPython documentation build configuration file. | |
4 |
|
4 | |||
5 | # NOTE: This file has been edited manually from the auto-generated one from |
|
5 | # NOTE: This file has been edited manually from the auto-generated one from | |
6 | # sphinx. Do NOT delete and re-generate. If any changes from sphinx are |
|
6 | # sphinx. Do NOT delete and re-generate. If any changes from sphinx are | |
7 | # needed, generate a scratch one and merge by hand any new fields needed. |
|
7 | # needed, generate a scratch one and merge by hand any new fields needed. | |
8 |
|
8 | |||
9 | # |
|
9 | # | |
10 | # This file is execfile()d with the current directory set to its containing dir. |
|
10 | # This file is execfile()d with the current directory set to its containing dir. | |
11 | # |
|
11 | # | |
12 | # The contents of this file are pickled, so don't put values in the namespace |
|
12 | # The contents of this file are pickled, so don't put values in the namespace | |
13 | # that aren't pickleable (module imports are okay, they're removed automatically). |
|
13 | # that aren't pickleable (module imports are okay, they're removed automatically). | |
14 | # |
|
14 | # | |
15 | # All configuration values have a default value; values that are commented out |
|
15 | # All configuration values have a default value; values that are commented out | |
16 | # serve to show the default value. |
|
16 | # serve to show the default value. | |
17 |
|
17 | |||
18 | import sys, os |
|
18 | import sys, os | |
19 |
|
19 | |||
20 | ON_RTD = os.environ.get('READTHEDOCS', None) == 'True' |
|
20 | ON_RTD = os.environ.get('READTHEDOCS', None) == 'True' | |
21 |
|
21 | |||
22 | if ON_RTD: |
|
22 | if ON_RTD: | |
23 | # Mock the presence of matplotlib, which we don't have on RTD |
|
23 | # Mock the presence of matplotlib, which we don't have on RTD | |
24 | # see |
|
24 | # see | |
25 | # http://read-the-docs.readthedocs.org/en/latest/faq.html |
|
25 | # http://read-the-docs.readthedocs.org/en/latest/faq.html | |
26 | tags.add('rtd') |
|
26 | tags.add('rtd') | |
27 |
|
27 | |||
28 | # If your extensions are in another directory, add it here. If the directory |
|
28 | # If your extensions are in another directory, add it here. If the directory | |
29 | # is relative to the documentation root, use os.path.abspath to make it |
|
29 | # is relative to the documentation root, use os.path.abspath to make it | |
30 | # absolute, like shown here. |
|
30 | # absolute, like shown here. | |
31 | sys.path.insert(0, os.path.abspath('../sphinxext')) |
|
31 | sys.path.insert(0, os.path.abspath('../sphinxext')) | |
32 |
|
32 | |||
33 | # Import support for ipython console session syntax highlighting (lives |
|
33 | # Import support for ipython console session syntax highlighting (lives | |
34 | # in the sphinxext directory defined above) |
|
34 | # in the sphinxext directory defined above) | |
35 | import ipython_console_highlighting |
|
35 | import ipython_console_highlighting | |
36 |
|
36 | |||
37 | # We load the ipython release info into a dict by explicit execution |
|
37 | # We load the ipython release info into a dict by explicit execution | |
38 | iprelease = {} |
|
38 | iprelease = {} | |
39 | execfile('../../IPython/core/release.py',iprelease) |
|
39 | execfile('../../IPython/core/release.py',iprelease) | |
40 |
|
40 | |||
41 | # General configuration |
|
41 | # General configuration | |
42 | # --------------------- |
|
42 | # --------------------- | |
43 |
|
43 | |||
44 | # Add any Sphinx extension module names here, as strings. They can be extensions |
|
44 | # Add any Sphinx extension module names here, as strings. They can be extensions | |
45 | # coming with Sphinx (named 'sphinx.ext.*') or your custom ones. |
|
45 | # coming with Sphinx (named 'sphinx.ext.*') or your custom ones. | |
46 | extensions = [ |
|
46 | extensions = [ | |
47 | 'matplotlib.sphinxext.mathmpl', |
|
47 | 'matplotlib.sphinxext.mathmpl', | |
48 | 'matplotlib.sphinxext.only_directives', |
|
48 | 'matplotlib.sphinxext.only_directives', | |
49 | 'matplotlib.sphinxext.plot_directive', |
|
49 | 'matplotlib.sphinxext.plot_directive', | |
50 | 'sphinx.ext.autodoc', |
|
50 | 'sphinx.ext.autodoc', | |
51 | 'sphinx.ext.doctest', |
|
51 | 'sphinx.ext.doctest', | |
52 | 'inheritance_diagram', |
|
52 | 'inheritance_diagram', | |
53 | 'ipython_console_highlighting', |
|
53 | 'ipython_console_highlighting', | |
54 | 'ipython_directive', |
|
54 | 'ipython_directive', | |
55 | 'numpydoc', # to preprocess docstrings |
|
55 | 'numpydoc', # to preprocess docstrings | |
56 | 'github', # for easy GitHub links |
|
56 | 'github', # for easy GitHub links | |
57 | ] |
|
57 | ] | |
58 |
|
58 | |||
59 | if ON_RTD: |
|
59 | if ON_RTD: | |
60 | # Remove extensions not currently supported on RTD |
|
60 | # Remove extensions not currently supported on RTD | |
61 | extensions.remove('matplotlib.sphinxext.only_directives') |
|
61 | extensions.remove('matplotlib.sphinxext.only_directives') | |
62 | extensions.remove('matplotlib.sphinxext.mathmpl') |
|
62 | extensions.remove('matplotlib.sphinxext.mathmpl') | |
63 | extensions.remove('matplotlib.sphinxext.plot_directive') |
|
63 | extensions.remove('matplotlib.sphinxext.plot_directive') | |
64 | extensions.remove('ipython_directive') |
|
64 | extensions.remove('ipython_directive') | |
65 |
|
65 | |||
66 | # Add any paths that contain templates here, relative to this directory. |
|
66 | # Add any paths that contain templates here, relative to this directory. | |
67 | templates_path = ['_templates'] |
|
67 | templates_path = ['_templates'] | |
68 |
|
68 | |||
69 | # The suffix of source filenames. |
|
69 | # The suffix of source filenames. | |
70 | source_suffix = '.txt' |
|
70 | source_suffix = '.txt' | |
71 |
|
71 | |||
72 | # The master toctree document. |
|
72 | # The master toctree document. | |
73 | master_doc = 'index' |
|
73 | master_doc = 'index' | |
74 |
|
74 | |||
75 | # General substitutions. |
|
75 | # General substitutions. | |
76 | project = 'IPython' |
|
76 | project = 'IPython' | |
77 | copyright = '2008, The IPython Development Team' |
|
77 | copyright = '2008, The IPython Development Team' | |
78 |
|
78 | |||
79 | # ghissue config |
|
79 | # ghissue config | |
80 | github_project_url = "https://github.com/ipython/ipython" |
|
80 | github_project_url = "https://github.com/ipython/ipython" | |
81 |
|
81 | |||
82 | # The default replacements for |version| and |release|, also used in various |
|
82 | # The default replacements for |version| and |release|, also used in various | |
83 | # other places throughout the built documents. |
|
83 | # other places throughout the built documents. | |
84 | # |
|
84 | # | |
85 | # The full version, including alpha/beta/rc tags. |
|
85 | # The full version, including alpha/beta/rc tags. | |
86 | release = iprelease['version'] |
|
86 | release = iprelease['version'] | |
87 | # The short X.Y version. |
|
87 | # The short X.Y version. | |
88 | version = '.'.join(release.split('.',2)[:2]) |
|
88 | version = '.'.join(release.split('.',2)[:2]) | |
89 |
|
89 | |||
90 |
|
90 | |||
91 | # There are two options for replacing |today|: either, you set today to some |
|
91 | # There are two options for replacing |today|: either, you set today to some | |
92 | # non-false value, then it is used: |
|
92 | # non-false value, then it is used: | |
93 | #today = '' |
|
93 | #today = '' | |
94 | # Else, today_fmt is used as the format for a strftime call. |
|
94 | # Else, today_fmt is used as the format for a strftime call. | |
95 | today_fmt = '%B %d, %Y' |
|
95 | today_fmt = '%B %d, %Y' | |
96 |
|
96 | |||
97 | # List of documents that shouldn't be included in the build. |
|
97 | # List of documents that shouldn't be included in the build. | |
98 | #unused_docs = [] |
|
98 | #unused_docs = [] | |
99 |
|
99 | |||
100 | # List of directories, relative to source directories, that shouldn't be searched |
|
100 | # List of directories, relative to source directories, that shouldn't be searched | |
101 | # for source files. |
|
101 | # for source files. | |
102 | exclude_dirs = ['attic'] |
|
102 | exclude_dirs = ['attic'] | |
103 |
|
103 | |||
104 | # If true, '()' will be appended to :func: etc. cross-reference text. |
|
104 | # If true, '()' will be appended to :func: etc. cross-reference text. | |
105 | #add_function_parentheses = True |
|
105 | #add_function_parentheses = True | |
106 |
|
106 | |||
107 | # If true, the current module name will be prepended to all description |
|
107 | # If true, the current module name will be prepended to all description | |
108 | # unit titles (such as .. function::). |
|
108 | # unit titles (such as .. function::). | |
109 | #add_module_names = True |
|
109 | #add_module_names = True | |
110 |
|
110 | |||
111 | # If true, sectionauthor and moduleauthor directives will be shown in the |
|
111 | # If true, sectionauthor and moduleauthor directives will be shown in the | |
112 | # output. They are ignored by default. |
|
112 | # output. They are ignored by default. | |
113 | #show_authors = False |
|
113 | #show_authors = False | |
114 |
|
114 | |||
115 | # The name of the Pygments (syntax highlighting) style to use. |
|
115 | # The name of the Pygments (syntax highlighting) style to use. | |
116 | pygments_style = 'sphinx' |
|
116 | pygments_style = 'sphinx' | |
117 |
|
117 | |||
118 |
|
118 | |||
119 | # Options for HTML output |
|
119 | # Options for HTML output | |
120 | # ----------------------- |
|
120 | # ----------------------- | |
121 |
|
121 | |||
122 | # The style sheet to use for HTML and HTML Help pages. A file of that name |
|
122 | # The style sheet to use for HTML and HTML Help pages. A file of that name | |
123 | # must exist either in Sphinx' static/ path, or in one of the custom paths |
|
123 | # must exist either in Sphinx' static/ path, or in one of the custom paths | |
124 | # given in html_static_path. |
|
124 | # given in html_static_path. | |
125 | html_style = 'default.css' |
|
125 | html_style = 'default.css' | |
126 |
|
126 | |||
127 | # The name for this set of Sphinx documents. If None, it defaults to |
|
127 | # The name for this set of Sphinx documents. If None, it defaults to | |
128 | # "<project> v<release> documentation". |
|
128 | # "<project> v<release> documentation". | |
129 | #html_title = None |
|
129 | #html_title = None | |
130 |
|
130 | |||
131 | # The name of an image file (within the static path) to place at the top of |
|
131 | # The name of an image file (within the static path) to place at the top of | |
132 | # the sidebar. |
|
132 | # the sidebar. | |
133 | #html_logo = None |
|
133 | #html_logo = None | |
134 |
|
134 | |||
135 | # Add any paths that contain custom static files (such as style sheets) here, |
|
135 | # Add any paths that contain custom static files (such as style sheets) here, | |
136 | # relative to this directory. They are copied after the builtin static files, |
|
136 | # relative to this directory. They are copied after the builtin static files, | |
137 | # so a file named "default.css" will overwrite the builtin "default.css". |
|
137 | # so a file named "default.css" will overwrite the builtin "default.css". | |
138 | html_static_path = ['_static'] |
|
138 | html_static_path = ['_static'] | |
139 |
|
139 | |||
140 | # If not '', a 'Last updated on:' timestamp is inserted at every page bottom, |
|
140 | # If not '', a 'Last updated on:' timestamp is inserted at every page bottom, | |
141 | # using the given strftime format. |
|
141 | # using the given strftime format. | |
142 | html_last_updated_fmt = '%b %d, %Y' |
|
142 | html_last_updated_fmt = '%b %d, %Y' | |
143 |
|
143 | |||
144 | # If true, SmartyPants will be used to convert quotes and dashes to |
|
144 | # If true, SmartyPants will be used to convert quotes and dashes to | |
145 | # typographically correct entities. |
|
145 | # typographically correct entities. | |
146 | #html_use_smartypants = True |
|
146 | #html_use_smartypants = True | |
147 |
|
147 | |||
148 | # Custom sidebar templates, maps document names to template names. |
|
148 | # Custom sidebar templates, maps document names to template names. | |
149 | #html_sidebars = {} |
|
149 | #html_sidebars = {} | |
150 |
|
150 | |||
151 | # Additional templates that should be rendered to pages, maps page names to |
|
151 | # Additional templates that should be rendered to pages, maps page names to | |
152 | # template names. |
|
152 | # template names. | |
153 | #html_additional_pages = {} |
|
153 | #html_additional_pages = {} | |
154 |
|
154 | |||
155 | # If false, no module index is generated. |
|
155 | # If false, no module index is generated. | |
156 | #html_use_modindex = True |
|
156 | #html_use_modindex = True | |
157 |
|
157 | |||
158 | # If true, the reST sources are included in the HTML build as _sources/<name>. |
|
158 | # If true, the reST sources are included in the HTML build as _sources/<name>. | |
159 | #html_copy_source = True |
|
159 | #html_copy_source = True | |
160 |
|
160 | |||
161 | # If true, an OpenSearch description file will be output, and all pages will |
|
161 | # If true, an OpenSearch description file will be output, and all pages will | |
162 | # contain a <link> tag referring to it. The value of this option must be the |
|
162 | # contain a <link> tag referring to it. The value of this option must be the | |
163 | # base URL from which the finished HTML is served. |
|
163 | # base URL from which the finished HTML is served. | |
164 | #html_use_opensearch = '' |
|
164 | #html_use_opensearch = '' | |
165 |
|
165 | |||
166 | # If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml"). |
|
166 | # If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml"). | |
167 | #html_file_suffix = '' |
|
167 | #html_file_suffix = '' | |
168 |
|
168 | |||
169 | # Output file base name for HTML help builder. |
|
169 | # Output file base name for HTML help builder. | |
170 | htmlhelp_basename = 'ipythondoc' |
|
170 | htmlhelp_basename = 'ipythondoc' | |
171 |
|
171 | |||
172 |
|
172 | |||
173 | # Options for LaTeX output |
|
173 | # Options for LaTeX output | |
174 | # ------------------------ |
|
174 | # ------------------------ | |
175 |
|
175 | |||
176 | # The paper size ('letter' or 'a4'). |
|
176 | # The paper size ('letter' or 'a4'). | |
177 | latex_paper_size = 'letter' |
|
177 | latex_paper_size = 'letter' | |
178 |
|
178 | |||
179 | # The font size ('10pt', '11pt' or '12pt'). |
|
179 | # The font size ('10pt', '11pt' or '12pt'). | |
180 | latex_font_size = '11pt' |
|
180 | latex_font_size = '11pt' | |
181 |
|
181 | |||
182 | # Grouping the document tree into LaTeX files. List of tuples |
|
182 | # Grouping the document tree into LaTeX files. List of tuples | |
183 | # (source start file, target name, title, author, document class [howto/manual]). |
|
183 | # (source start file, target name, title, author, document class [howto/manual]). | |
184 |
|
184 | |||
185 | latex_documents = [ |
|
185 | latex_documents = [ | |
186 | ('index', 'ipython.tex', 'IPython Documentation', |
|
186 | ('index', 'ipython.tex', 'IPython Documentation', | |
187 | ur"""The IPython Development Team""", 'manual', True), |
|
187 | ur"""The IPython Development Team""", 'manual', True), | |
188 | ('parallel/winhpc_index', 'winhpc_whitepaper.tex', |
|
188 | ('parallel/winhpc_index', 'winhpc_whitepaper.tex', | |
189 | 'Using IPython on Windows HPC Server 2008', |
|
189 | 'Using IPython on Windows HPC Server 2008', | |
190 | ur"Brian E. Granger", 'manual', True) |
|
190 | ur"Brian E. Granger", 'manual', True) | |
191 | ] |
|
191 | ] | |
192 |
|
192 | |||
193 | # The name of an image file (relative to this directory) to place at the top of |
|
193 | # The name of an image file (relative to this directory) to place at the top of | |
194 | # the title page. |
|
194 | # the title page. | |
195 | #latex_logo = None |
|
195 | #latex_logo = None | |
196 |
|
196 | |||
197 | # For "manual" documents, if this is true, then toplevel headings are parts, |
|
197 | # For "manual" documents, if this is true, then toplevel headings are parts, | |
198 | # not chapters. |
|
198 | # not chapters. | |
199 | #latex_use_parts = False |
|
199 | #latex_use_parts = False | |
200 |
|
200 | |||
201 | # Additional stuff for the LaTeX preamble. |
|
201 | # Additional stuff for the LaTeX preamble. | |
202 | #latex_preamble = '' |
|
202 | #latex_preamble = '' | |
203 |
|
203 | |||
204 | # Documents to append as an appendix to all manuals. |
|
204 | # Documents to append as an appendix to all manuals. | |
205 | #latex_appendices = [] |
|
205 | #latex_appendices = [] | |
206 |
|
206 | |||
207 | # If false, no module index is generated. |
|
207 | # If false, no module index is generated. | |
208 | latex_use_modindex = True |
|
208 | latex_use_modindex = True | |
209 |
|
209 | |||
210 |
|
210 | |||
|
211 | # Options for texinfo output | |||
|
212 | # -------------------------- | |||
|
213 | ||||
|
214 | texinfo_documents = [ | |||
|
215 | (master_doc, 'ipython', 'IPython Documentation', | |||
|
216 | 'The IPython Development Team', | |||
|
217 | 'IPython', | |||
|
218 | 'IPython Documentation', | |||
|
219 | 'Programming', | |||
|
220 | 1), | |||
|
221 | ] | |||
|
222 | ||||
|
223 | ||||
211 | # Cleanup |
|
224 | # Cleanup | |
212 | # ------- |
|
225 | # ------- | |
213 | # delete release info to avoid pickling errors from sphinx |
|
226 | # delete release info to avoid pickling errors from sphinx | |
214 |
|
227 | |||
215 | del iprelease |
|
228 | del iprelease |
General Comments 0
You need to be logged in to leave comments.
Login now