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