docs/conf.py
branchstable
changeset 2259 94432e742a02
parent 2034 fc6183051112
child 2950 1b4c92621e23
equal deleted inserted replaced
1814:efda653c96a7 2259:94432e742a02
     1 # Add any Sphinx extension module names here, as strings. They can be extensions
     1 # Add any Sphinx extension module names here, as strings. They can be extensions
     2 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
     2 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
     3 extensions = []
     3 extensions = []
     4 #autoclass_content = 'both'
     4 # autoclass_content = 'both'
     5 # Add any paths that contain templates here, relative to this directory.
     5 # Add any paths that contain templates here, relative to this directory.
     6 #templates_path = []
     6 # templates_path = []
     7 
     7 
     8 # The suffix of source filenames.
     8 # The suffix of source filenames.
     9 source_suffix = '.rst'
     9 source_suffix = '.rst'
    10 
    10 
    11 # The master toctree document.
    11 # The master toctree document.
    23 # The full version, including alpha/beta/rc tags.
    23 # The full version, including alpha/beta/rc tags.
    24 release = '0.0'
    24 release = '0.0'
    25 
    25 
    26 # There are two options for replacing |today|: either, you set today to some
    26 # There are two options for replacing |today|: either, you set today to some
    27 # non-false value, then it is used:
    27 # non-false value, then it is used:
    28 #today = ''
    28 # today = ''
    29 # Else, today_fmt is used as the format for a strftime call.
    29 # Else, today_fmt is used as the format for a strftime call.
    30 today_fmt = '%B %d, %Y'
    30 today_fmt = '%B %d, %Y'
    31 
    31 
    32 # List of documents that shouldn't be included in the build.
    32 # List of documents that shouldn't be included in the build.
    33 unused_docs = []
    33 unused_docs = []
    34 
    34 
    35 # List of directories, relative to source directories, that shouldn't be searched
    35 # List of directories, relative to source directories, that shouldn't be searched
    36 # for source files.
    36 # for source files.
    37 #exclude_dirs = []
    37 # exclude_dirs = []
    38 
    38 
    39 # The reST default role (used for this markup: `text`) to use for all documents.
    39 # The reST default role (used for this markup: `text`) to use for all documents.
    40 #default_role = None
    40 # default_role = None
    41 
    41 
    42 # If true, '()' will be appended to :func: etc. cross-reference text.
    42 # If true, '()' will be appended to :func: etc. cross-reference text.
    43 #add_function_parentheses = True
    43 # add_function_parentheses = True
    44 
    44 
    45 # If true, the current module name will be prepended to all description
    45 # If true, the current module name will be prepended to all description
    46 # unit titles (such as .. function::).
    46 # unit titles (such as .. function::).
    47 #add_module_names = True
    47 # add_module_names = True
    48 
    48 
    49 # If true, sectionauthor and moduleauthor directives will be shown in the
    49 # If true, sectionauthor and moduleauthor directives will be shown in the
    50 # output. They are ignored by default.
    50 # output. They are ignored by default.
    51 #show_authors = False
    51 # show_authors = False
    52 
    52 
    53 # The name of the Pygments (syntax highlighting) style to use.
    53 # The name of the Pygments (syntax highlighting) style to use.
    54 pygments_style = 'sphinx'
    54 pygments_style = 'sphinx'
    55 
    55 
    56 
    56 
    58 # -----------------------
    58 # -----------------------
    59 
    59 
    60 # The style sheet to use for HTML and HTML Help pages. A file of that name
    60 # The style sheet to use for HTML and HTML Help pages. A file of that name
    61 # must exist either in Sphinx' static/ path, or in one of the custom paths
    61 # must exist either in Sphinx' static/ path, or in one of the custom paths
    62 # given in html_static_path.
    62 # given in html_static_path.
    63 #html_style = 'sphinx-default.css'
    63 # html_style = 'sphinx-default.css'
    64 
    64 
    65 # The name for this set of Sphinx documents.  If None, it defaults to
    65 # The name for this set of Sphinx documents.  If None, it defaults to
    66 # "<project> v<release> documentation".
    66 # "<project> v<release> documentation".
    67 html_title = project
    67 html_title = project
    68 html_theme = 'haiku'
    68 html_theme = 'haiku'
    69 html_theme_path = ['.']
    69 html_theme_path = ['.']
    70 
    70 
    71 # A shorter title for the navigation bar.  Default is the same as html_title.
    71 # A shorter title for the navigation bar.  Default is the same as html_title.
    72 #html_short_title = None
    72 # html_short_title = None
    73 
    73 
    74 # The name of an image file (within the static path) to place at the top of
    74 # The name of an image file (within the static path) to place at the top of
    75 # the sidebar.
    75 # the sidebar.
    76 #html_logo = 'logo-evolve.svg'
    76 # html_logo = 'logo-evolve.svg'
    77 
    77 
    78 # The name of an image file (within the static path) to use as favicon of the
    78 # The name of an image file (within the static path) to use as favicon of the
    79 # docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
    79 # docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
    80 # pixels large.
    80 # pixels large.
    81 html_favicon = 'logo-evolve.ico'
    81 html_favicon = 'logo-evolve.ico'
    89 # using the given strftime format.
    89 # using the given strftime format.
    90 html_last_updated_fmt = '%b %d, %Y'
    90 html_last_updated_fmt = '%b %d, %Y'
    91 
    91 
    92 # If true, SmartyPants will be used to convert quotes and dashes to
    92 # If true, SmartyPants will be used to convert quotes and dashes to
    93 # typographically correct entities.
    93 # typographically correct entities.
    94 #html_use_smartypants = True
    94 # html_use_smartypants = True
    95 
    95 
    96 # Custom sidebar templates, maps document names to template names.
    96 # Custom sidebar templates, maps document names to template names.
    97 #html_sidebars = {}
    97 # html_sidebars = {}
    98 
    98 
    99 # Additional templates that should be rendered to pages, maps page names to
    99 # Additional templates that should be rendered to pages, maps page names to
   100 # template names.
   100 # template names.
   101 #html_additional_pages = {}
   101 # html_additional_pages = {}
   102 
   102 
   103 # If false, no module index is generated.
   103 # If false, no module index is generated.
   104 html_use_modindex = False
   104 html_use_modindex = False
   105 
   105 
   106 # If false, no index is generated.
   106 # If false, no index is generated.
   107 #html_use_index = True
   107 # html_use_index = True
   108 
   108 
   109 # If true, the index is split into individual pages for each letter.
   109 # If true, the index is split into individual pages for each letter.
   110 #html_split_index = False
   110 # html_split_index = False
   111 
   111 
   112 # If true, the reST sources are included in the HTML build as _sources/<name>.
   112 # If true, the reST sources are included in the HTML build as _sources/<name>.
   113 #html_copy_source = True
   113 # html_copy_source = True
   114 
   114 
   115 # If true, an OpenSearch description file will be output, and all pages will
   115 # If true, an OpenSearch description file will be output, and all pages will
   116 # contain a <link> tag referring to it.  The value of this option must be the
   116 # contain a <link> tag referring to it.  The value of this option must be the
   117 # base URL from which the finished HTML is served.
   117 # base URL from which the finished HTML is served.
   118 #html_use_opensearch = ''
   118 # html_use_opensearch = ''
   119 
   119 
   120 # If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml").
   120 # If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml").
   121 #html_file_suffix = '.html'
   121 # html_file_suffix = '.html'
   122 
   122 
   123 # Output file base name for HTML help builder.
   123 # Output file base name for HTML help builder.
   124 #htmlhelp_basename = ''
   124 # htmlhelp_basename = ''