1  # -*- coding: utf-8 -*-
  2  #
  3  # format documentation build configuration file, created by
  4  # sphinx-quickstart on Tue Dec 18 06:46:16 2012.
  5  #
  6  # This file is execfile()d with the current directory set to its containing dir.
  7  #
  8  # Note that not all possible configuration values are present in this
  9  # autogenerated file.
 10  #
 11  # All configuration values have a default; values that are commented out
 12  # serve to show the default.
 13  
 14  import sys, os, re, subprocess
 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  #sys.path.insert(0, os.path.abspath('.'))
 20  
 21  # -- General configuration -----------------------------------------------------
 22  
 23  # If your documentation needs a minimal Sphinx version, state it here.
 24  needs_sphinx = '1.2'
 25  
 26  if os.environ.get('READTHEDOCS', None) == 'True':
 27    subprocess.call('doxygen')
 28  
 29  # Add any Sphinx extension module names here, as strings. They can be extensions
 30  # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
 31  extensions = ['sphinx.ext.ifconfig', 'breathe']
 32  
 33  breathe_default_project = "format"
 34  breathe_domain_by_extension = {"h" : "cpp"}
 35  
 36  # Add any paths that contain templates here, relative to this directory.
 37  templates_path = ['_templates']
 38  
 39  # The suffix of source filenames.
 40  source_suffix = '.rst'
 41  
 42  # The encoding of source files.
 43  #source_encoding = 'utf-8-sig'
 44  
 45  # The master toctree document.
 46  #master_doc = 'contents'
 47  
 48  # General information about the project.
 49  project = u'fmt'
 50  copyright = u'2012-present, Victor Zverovich'
 51  
 52  # The version info for the project you're documenting, acts as replacement for
 53  # |version| and |release|, also used in various other places throughout the
 54  # built documents.
 55  #
 56  # The short X.Y version.
 57  
 58  # Version and release are passed from CMake.
 59  #version = None
 60  
 61  # The full version, including alpha/beta/rc tags.
 62  #release = version
 63  
 64  # The language for content autogenerated by Sphinx. Refer to documentation
 65  # for a list of supported languages.
 66  #language = None
 67  
 68  # There are two options for replacing |today|: either, you set today to some
 69  # non-false value, then it is used:
 70  #today = ''
 71  # Else, today_fmt is used as the format for a strftime call.
 72  #today_fmt = '%B %d, %Y'
 73  
 74  # List of patterns, relative to source directory, that match files and
 75  # directories to ignore when looking for source files.
 76  exclude_patterns = ['virtualenv']
 77  
 78  # The reST default role (used for this markup: `text`) to use for all documents.
 79  default_role = 'cpp:any'
 80  
 81  # If true, '()' will be appended to :func: etc. cross-reference text.
 82  #add_function_parentheses = True
 83  
 84  # If true, the current module name will be prepended to all description
 85  # unit titles (such as .. function::).
 86  #add_module_names = True
 87  
 88  # If true, sectionauthor and moduleauthor directives will be shown in the
 89  # output. They are ignored by default.
 90  #show_authors = False
 91  
 92  # The name of the Pygments (syntax highlighting) style to use.
 93  pygments_style = 'sphinx'
 94  
 95  highlight_language = 'c++'
 96  
 97  primary_domain = 'cpp'
 98  
 99  # A list of ignored prefixes for module index sorting.
100  #modindex_common_prefix = []
101  
102  
103  # -- Options for HTML output ---------------------------------------------------
104  
105  # The theme to use for HTML and HTML Help pages.  See the documentation for
106  # a list of builtin themes.
107  html_theme = 'basic-bootstrap'
108  
109  # Theme options are theme-specific and customize the look and feel of a theme
110  # further.  For a list of options available for each theme, see the
111  # documentation.
112  #html_theme_options = {}
113  
114  # Add any paths that contain custom themes here, relative to this directory.
115  html_theme_path = ['.']
116  
117  # The name for this set of Sphinx documents.  If None, it defaults to
118  # "<project> v<release> documentation".
119  #html_title = None
120  
121  # A shorter title for the navigation bar.  Default is the same as html_title.
122  #html_short_title = None
123  
124  # The name of an image file (relative to this directory) to place at the top
125  # of the sidebar.
126  #html_logo = None
127  
128  # The name of an image file (within the static path) to use as favicon of the
129  # docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
130  # pixels large.
131  #html_favicon = None
132  
133  # Add any paths that contain custom static files (such as style sheets) here,
134  # relative to this directory. They are copied after the builtin static files,
135  # so a file named "default.css" will overwrite the builtin "default.css".
136  html_static_path = ['_static']
137  
138  # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
139  # using the given strftime format.
140  #html_last_updated_fmt = '%b %d, %Y'
141  
142  # If true, SmartyPants will be used to convert quotes and dashes to
143  # typographically correct entities.
144  #html_use_smartypants = True
145  
146  # Custom sidebar templates, maps document names to template names.
147  html_sidebars = {
148    '**': ['localtoc.html', 'relations.html', 'sourcelink.html', 'searchbox.html']
149  }
150  
151  # Additional templates that should be rendered to pages, maps page names to
152  # template names.
153  #html_additional_pages = {}
154  
155  # If false, no module index is generated.
156  #html_domain_indices = True
157  
158  # If false, no index is generated.
159  #html_use_index = True
160  
161  # If true, the index is split into individual pages for each letter.
162  #html_split_index = False
163  
164  # If true, links to the reST sources are added to the pages.
165  #html_show_sourcelink = True
166  
167  # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
168  #html_show_sphinx = True
169  
170  # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
171  #html_show_copyright = True
172  
173  # If true, an OpenSearch description file will be output, and all pages will
174  # contain a <link> tag referring to it.  The value of this option must be the
175  # base URL from which the finished HTML is served.
176  #html_use_opensearch = ''
177  
178  # This is the file name suffix for HTML files (e.g. ".xhtml").
179  #html_file_suffix = None
180  
181  # Output file base name for HTML help builder.
182  htmlhelp_basename = 'formatdoc'
183  
184  
185  # -- Options for LaTeX output --------------------------------------------------
186  
187  latex_elements = {
188  # The paper size ('letterpaper' or 'a4paper').
189  #'papersize': 'letterpaper',
190  
191  # The font size ('10pt', '11pt' or '12pt').
192  #'pointsize': '10pt',
193  
194  # Additional stuff for the LaTeX preamble.
195  #'preamble': '',
196  }
197  
198  # Grouping the document tree into LaTeX files. List of tuples
199  # (source start file, target name, title, author, documentclass [howto/manual]).
200  latex_documents = [
201    ('index', 'format.tex', u'fmt documentation',
202     u'Victor Zverovich', 'manual'),
203  ]
204  
205  # The name of an image file (relative to this directory) to place at the top of
206  # the title page.
207  #latex_logo = None
208  
209  # For "manual" documents, if this is true, then toplevel headings are parts,
210  # not chapters.
211  #latex_use_parts = False
212  
213  # If true, show page references after internal links.
214  #latex_show_pagerefs = False
215  
216  # If true, show URL addresses after external links.
217  #latex_show_urls = False
218  
219  # Documents to append as an appendix to all manuals.
220  #latex_appendices = []
221  
222  # If false, no module index is generated.
223  #latex_domain_indices = True
224  
225  
226  # -- Options for manual page output --------------------------------------------
227  
228  # One entry per manual page. List of tuples
229  # (source start file, name, description, authors, manual section).
230  man_pages = [
231      ('index', 'fmt', u'fmt documentation', [u'Victor Zverovich'], 1)
232  ]
233  
234  # If true, show URL addresses after external links.
235  #man_show_urls = False
236  
237  
238  # -- Options for Texinfo output ------------------------------------------------
239  
240  # Grouping the document tree into Texinfo files. List of tuples
241  # (source start file, target name, title, author,
242  #  dir menu entry, description, category)
243  texinfo_documents = [
244    ('index', 'fmt', u'fmt documentation',
245     u'Victor Zverovich', 'fmt', 'One line description of project.',
246     'Miscellaneous'),
247  ]
248  
249  # Documents to append as an appendix to all manuals.
250  #texinfo_appendices = []
251  
252  # If false, no module index is generated.
253  #texinfo_domain_indices = True
254  
255  # How to display URL addresses: 'footnote', 'no', or 'inline'.
256  #texinfo_show_urls = 'footnote'