|
1 #!/var/local/env/pycharm/bin/python3.5 |
|
2 # -*- coding: utf-8 -*- |
|
3 # |
|
4 # PyAMS User Guide documentation build configuration file, created by |
|
5 # sphinx-quickstart on Fri Dec 15 17:15:54 2017. |
|
6 # |
|
7 # This file is execfile()d with the current directory set to its |
|
8 # containing dir. |
|
9 # |
|
10 # Note that not all possible configuration values are present in this |
|
11 # autogenerated file. |
|
12 # |
|
13 # All configuration values have a default; values that are commented out |
|
14 # serve to show the default. |
|
15 |
|
16 # If extensions (or modules to document with autodoc) are in another directory, |
|
17 # add these directories to sys.path here. If the directory is relative to the |
|
18 # documentation root, use os.path.abspath to make it absolute, like shown here. |
|
19 # |
|
20 # import sys |
|
21 # sys.path.insert(0, '/var/local/env/pycharm/lib/python3.5/site-packages') |
|
22 |
|
23 # -- General configuration ------------------------------------------------ |
|
24 |
|
25 # If your documentation needs a minimal Sphinx version, state it here. |
|
26 # |
|
27 # needs_sphinx = '1.0' |
|
28 |
|
29 # Add any Sphinx extension module names here, as strings. They can be |
|
30 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom |
|
31 # ones. |
|
32 extensions = [ |
|
33 'sphinx.ext.autodoc', |
|
34 ] |
|
35 |
|
36 # Add any paths that contain templates here, relative to this directory. |
|
37 templates_path = ['_templates'] |
|
38 |
|
39 # The suffix(es) of source filenames. |
|
40 # You can specify multiple suffix as a list of string: |
|
41 # |
|
42 # source_suffix = ['.rst', '.md'] |
|
43 source_suffix = '.rst' |
|
44 |
|
45 # The master toctree document. |
|
46 master_doc = 'index' |
|
47 |
|
48 # General information about the project. |
|
49 project = 'PyAMS User Guide' |
|
50 copyright = '2017, Thierry Florac' |
|
51 author = 'Thierry Florac' |
|
52 |
|
53 # The version info for the project you're documenting, acts as replacement for |
|
54 # |version| and |release|, also used in various other places throughout the |
|
55 # built documents. |
|
56 # |
|
57 # The short X.Y version. |
|
58 version = '0.1' |
|
59 # The full version, including alpha/beta/rc tags. |
|
60 release = '0.1.0' |
|
61 |
|
62 # The language for content autogenerated by Sphinx. Refer to documentation |
|
63 # for a list of supported languages. |
|
64 # |
|
65 # This is also used if you do content translation via gettext catalogs. |
|
66 # Usually you set "language" from the command line for these cases. |
|
67 language = None |
|
68 |
|
69 # List of patterns, relative to source directory, that match files and |
|
70 # directories to ignore when looking for source files. |
|
71 # This patterns also effect to html_static_path and html_extra_path |
|
72 exclude_patterns = [] |
|
73 |
|
74 # The name of the Pygments (syntax highlighting) style to use. |
|
75 pygments_style = 'sphinx' |
|
76 |
|
77 # If true, `todo` and `todoList` produce output, else they produce nothing. |
|
78 todo_include_todos = False |
|
79 |
|
80 |
|
81 # -- Options for HTML output ---------------------------------------------- |
|
82 |
|
83 # The theme to use for HTML and HTML Help pages. See the documentation for |
|
84 # a list of builtin themes. |
|
85 # |
|
86 html_theme = 'pyramid' |
|
87 |
|
88 # Theme options are theme-specific and customize the look and feel of a theme |
|
89 # further. For a list of options available for each theme, see the |
|
90 # documentation. |
|
91 # |
|
92 # html_theme_options = {} |
|
93 |
|
94 # Add any paths that contain custom static files (such as style sheets) here, |
|
95 # relative to this directory. They are copied after the builtin static files, |
|
96 # so a file named "default.css" will overwrite the builtin "default.css". |
|
97 html_static_path = ['_static'] |
|
98 |
|
99 # Custom sidebar templates, must be a dictionary that maps document names |
|
100 # to template names. |
|
101 # |
|
102 # html_domain_indices = True |
|
103 |
|
104 |
|
105 # -- Options for HTMLHelp output ------------------------------------------ |
|
106 |
|
107 # Output file base name for HTML help builder. |
|
108 htmlhelp_basename = 'PyAMSUserGuidedoc' |
|
109 |
|
110 |
|
111 # -- Options for LaTeX output --------------------------------------------- |
|
112 |
|
113 latex_elements = { |
|
114 # The paper size ('letterpaper' or 'a4paper'). |
|
115 # |
|
116 # 'papersize': 'letterpaper', |
|
117 |
|
118 # The font size ('10pt', '11pt' or '12pt'). |
|
119 # |
|
120 # 'pointsize': '10pt', |
|
121 |
|
122 # Additional stuff for the LaTeX preamble. |
|
123 # |
|
124 # 'preamble': '', |
|
125 |
|
126 # Latex figure (float) alignment |
|
127 # |
|
128 # 'figure_align': 'htbp', |
|
129 } |
|
130 |
|
131 # Grouping the document tree into LaTeX files. List of tuples |
|
132 # (source start file, target name, title, |
|
133 # author, documentclass [howto, manual, or own class]). |
|
134 latex_documents = [ |
|
135 (master_doc, 'PyAMSUserGuide.tex', 'PyAMS User Guide Documentation', |
|
136 'Thierry Florac', 'manual'), |
|
137 ] |
|
138 |
|
139 |
|
140 # -- Options for manual page output --------------------------------------- |
|
141 |
|
142 # One entry per manual page. List of tuples |
|
143 # (source start file, name, description, authors, manual section). |
|
144 man_pages = [ |
|
145 (master_doc, 'pyamsuserguide', 'PyAMS User Guide Documentation', |
|
146 [author], 1) |
|
147 ] |
|
148 |
|
149 |
|
150 # -- Options for Texinfo output ------------------------------------------- |
|
151 |
|
152 # Grouping the document tree into Texinfo files. List of tuples |
|
153 # (source start file, target name, title, author, |
|
154 # dir menu entry, description, category) |
|
155 texinfo_documents = [ |
|
156 (master_doc, 'PyAMSUserGuide', 'PyAMS User Guide Documentation', |
|
157 author, 'PyAMSUserGuide', 'One line description of project.', |
|
158 'Miscellaneous'), |
|
159 ] |
|
160 |
|
161 |
|
162 |
|
163 # -- Options for Epub output ---------------------------------------------- |
|
164 |
|
165 # Bibliographic Dublin Core info. |
|
166 epub_title = project |
|
167 epub_author = author |
|
168 epub_publisher = author |
|
169 epub_copyright = copyright |
|
170 |
|
171 # The unique identifier of the text. This can be a ISBN number |
|
172 # or the project homepage. |
|
173 # |
|
174 # epub_identifier = '' |
|
175 |
|
176 # A unique identification for the text. |
|
177 # |
|
178 # epub_uid = '' |
|
179 |
|
180 # A list of files that should not be packed into the epub file. |
|
181 epub_exclude_files = ['search.html'] |
|
182 |
|
183 |