| # Licensed to the Apache Software Foundation (ASF) under one |
| # or more contributor license agreements. See the NOTICE file |
| # distributed with this work for additional information# |
| # regarding copyright ownership. The ASF licenses this file |
| # to you under the Apache License, Version 2.0 (the |
| # "License"); you may not use this file except in compliance |
| # with the License. You may obtain a copy of the License at |
| # http://www.apache.org/licenses/LICENSE-2.0 |
| # |
| # Unless required by applicable law or agreed to in writing, |
| # software distributed under the License is distributed on an |
| # "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY |
| # KIND, either express or implied. See the License for the |
| # specific language governing permissions and limitations |
| # under the License. |
| |
| # -*- coding: utf-8 -*- |
| # |
| # CloudStack Release Notes documentation build configuration file, created by |
| # sphinx-quickstart on Fri Feb 7 16:00:59 2014. |
| # |
| # This file is execfile()d with the current directory set to its |
| # containing dir. |
| # |
| # Note that not all possible configuration values are present in this |
| # autogenerated file. |
| # |
| # All configuration values have a default; values that are commented out |
| # serve to show the default. |
| |
| import sys |
| import os |
| |
| sys.path.insert(0, os.path.abspath('../')) |
| import sphinx_bootstrap_theme |
| |
| # If extensions (or modules to document with autodoc) are in another directory, |
| # add these directories to sys.path here. If the directory is relative to the |
| # documentation root, use os.path.abspath to make it absolute, like shown here. |
| #sys.path.insert(0, os.path.abspath('.')) |
| |
| # -- General configuration ------------------------------------------------ |
| |
| # If your documentation needs a minimal Sphinx version, state it here. |
| #needs_sphinx = '1.0' |
| |
| # Add any Sphinx extension module names here, as strings. They can be |
| # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom |
| # ones. |
| extensions = ['sphinx.ext.autodoc', 'sphinx.ext.todo', 'sphinx.ext.ifconfig', 'sphinx.ext.viewcode'] |
| |
| # Add any paths that contain templates here, relative to this directory. |
| templates_path = ['_templates'] |
| |
| # Localization |
| locale_dirs = ['./locale/'] |
| gettext_compact = False |
| |
| # The suffix of source filenames. |
| source_suffix = '.rst' |
| |
| # The encoding of source files. |
| #source_encoding = 'utf-8-sig' |
| |
| # The master toctree document. |
| master_doc = 'index' |
| |
| # General information about the project. |
| project = u'Apache CloudStack Release Notes' |
| copyright = u'2018, Apache CloudStack' |
| |
| # The version info for the project you're documenting, acts as replacement for |
| # |version| and |release|, also used in various other places throughout the |
| # built documents. |
| # |
| # The short X.Y version. |
| version = '4.11' |
| # The full version, including alpha/beta/rc tags. |
| release = '4.11.1.0' |
| |
| # The language for content autogenerated by Sphinx. Refer to documentation |
| # for a list of supported languages. |
| #language = None |
| |
| # There are two options for replacing |today|: either, you set today to some |
| # non-false value, then it is used: |
| #today = '' |
| # Else, today_fmt is used as the format for a strftime call. |
| #today_fmt = '%B %d, %Y' |
| |
| # List of patterns, relative to source directory, that match files and |
| # directories to ignore when looking for source files. |
| exclude_patterns = [] |
| |
| # The reST default role (used for this markup: `text`) to use for all |
| # documents. |
| #default_role = None |
| |
| # If true, '()' will be appended to :func: etc. cross-reference text. |
| #add_function_parentheses = True |
| |
| # If true, the current module name will be prepended to all description |
| # unit titles (such as .. function::). |
| #add_module_names = True |
| |
| # If true, sectionauthor and moduleauthor directives will be shown in the |
| # output. They are ignored by default. |
| #show_authors = False |
| |
| # The name of the Pygments (syntax highlighting) style to use. |
| pygments_style = 'sphinx' |
| |
| # A list of ignored prefixes for module index sorting. |
| #modindex_common_prefix = [] |
| |
| # If true, keep warnings as "system message" paragraphs in the built documents. |
| #keep_warnings = False |
| |
| |
| # -- Options for HTML output ---------------------------------------------- |
| |
| # The theme to use for HTML and HTML Help pages. See the documentation for |
| # a list of builtin themes. |
| html_theme = 'bootstrap' |
| html_theme_options = { |
| # Navigation bar title. (Default: ``project`` value) |
| 'navbar_title': "Release Notes", |
| |
| # Tab name for entire site. (Default: "Site") |
| 'navbar_site_name': "Sections", |
| |
| # Tab name for the current pages TOC. (Default: "Page") |
| #'navbar_pagenav_name': "Page", |
| 'navbar_pagenav': "false", |
| # A list of tuples containing pages or urls to link to. |
| # Valid tuples should be in the following forms: |
| # (name, page) # a link to a page |
| # (name, "/aa/bb", 1) # a link to an arbitrary relative url |
| # (name, "http://example.com", True) # arbitrary absolute url |
| # Note the "1" or "True" value above as the third argument to indicate |
| # an arbitrary url. |
| # 'navbar_links': [ |
| # ("Examples", "examples"), |
| # ("Link", "http://example.com", True), |
| # ], |
| |
| # Global TOC depth for "site" navbar tab. (Default: 1) |
| # Switching to -1 shows all levels. |
| 'globaltoc_depth': 1, |
| |
| # Include hidden TOCs in Site navbar? |
| # |
| # Note: If this is "false", you cannot have mixed ``:hidden:`` and |
| # non-hidden ``toctree`` directives in the same page, or else the build |
| # will break. |
| # |
| # Values: "true" (default) or "false" |
| 'globaltoc_includehidden': "false", |
| |
| # HTML navbar class (Default: "navbar") to attach to <div> element. |
| # For black navbar, do "navbar navbar-inverse" |
| 'navbar_class': "navbar navbar-inverse", |
| |
| # Fix navigation bar to top of page? |
| # Values: "true" (default) or "false" |
| 'navbar_fixed_top': "true", |
| |
| # Location of link to source. |
| # Options are "nav" (default), "footer" or anything else to exclude. |
| 'source_link_position': "footer", |
| |
| # Bootswatch (http://bootswatch.com/) theme. |
| # |
| # Options are nothing (default) or the name of a valid theme such |
| # as "amelia" or "cosmo". |
| # |
| # Themes: |
| # * amelia |
| # * cerulean |
| # * cosmo |
| # * cyborg |
| # * cupid (v3 only) |
| # * flatly |
| # * journal |
| # * lumen (v3 only) |
| # * readable |
| # * simplex |
| # * slate |
| # * spacelab |
| # * spruce (v2 only) |
| # * superhero |
| # * united |
| # * yeti (v3 only) |
| 'bootswatch_theme': "spacelab", |
| |
| # Choose Bootstrap version. |
| # Values: "3" (default) or "2" (in quotes) |
| 'bootstrap_version': "3", |
| } |
| |
| # Add any paths that contain custom themes here, relative to this directory. |
| # ``get_html_theme_path`` returns a list, so you can concatenate with |
| # any other theme directories you would like. |
| html_theme_path = sphinx_bootstrap_theme.get_html_theme_path() |
| |
| |
| # The name for this set of Sphinx documents. If None, it defaults to |
| # "<project> v<release> documentation". |
| #html_title = None |
| |
| # A shorter title for the navigation bar. Default is the same as html_title. |
| #html_short_title = None |
| |
| # The name of an image file (relative to this directory) to place at the top |
| # of the sidebar. |
| #html_logo = '_static/images/acslogo.png' |
| |
| # The name of an image file (within the static path) to use as favicon of the |
| # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 |
| # pixels large. |
| #html_favicon = None |
| |
| # Add any paths that contain custom static files (such as style sheets) here, |
| # relative to this directory. They are copied after the builtin static files, |
| # so a file named "default.css" will overwrite the builtin "default.css". |
| html_static_path = ['_static'] |
| |
| #html_context = { |
| # 'css_files': [ |
| # '_static/theme_overrides.css', # overrides for wide tables in RTD theme |
| # ], |
| # } |
| # Add any extra paths that contain custom files (such as robots.txt or |
| # .htaccess) here, relative to this directory. These files are copied |
| # directly to the root of the documentation. |
| #html_extra_path = [] |
| |
| # If not '', a 'Last updated on:' timestamp is inserted at every page bottom, |
| # using the given strftime format. |
| #html_last_updated_fmt = '%b %d, %Y' |
| |
| # If true, SmartyPants will be used to convert quotes and dashes to |
| # typographically correct entities. |
| #html_use_smartypants = True |
| |
| # Custom sidebar templates, maps document names to template names. |
| #html_sidebars = {} |
| html_sidebars = { |
| '**': ['localtoc.html'], |
| 'index': ['globaltoc.html'] |
| } |
| |
| # Additional templates that should be rendered to pages, maps page names to |
| # template names. |
| #html_additional_pages = {} |
| |
| # If false, no module index is generated. |
| #html_domain_indices = True |
| |
| # If false, no index is generated. |
| #html_use_index = True |
| |
| # If true, the index is split into individual pages for each letter. |
| #html_split_index = False |
| |
| # If true, links to the reST sources are added to the pages. |
| #html_show_sourcelink = True |
| |
| # If true, "Created using Sphinx" is shown in the HTML footer. Default is True. |
| #html_show_sphinx = True |
| html_show_sphinx = False |
| |
| # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. |
| #html_show_copyright = True |
| |
| # If true, an OpenSearch description file will be output, and all pages will |
| # contain a <link> tag referring to it. The value of this option must be the |
| # base URL from which the finished HTML is served. |
| #html_use_opensearch = '' |
| |
| # This is the file name suffix for HTML files (e.g. ".xhtml"). |
| #html_file_suffix = None |
| |
| # Output file base name for HTML help builder. |
| htmlhelp_basename = 'CloudStackReleaseNotesdoc' |
| |
| |
| # -- Options for LaTeX output --------------------------------------------- |
| |
| latex_elements = { |
| # The paper size ('letterpaper' or 'a4paper'). |
| #'papersize': 'letterpaper', |
| |
| # The font size ('10pt', '11pt' or '12pt'). |
| #'pointsize': '10pt', |
| |
| # Additional stuff for the LaTeX preamble. |
| #'preamble': '', |
| } |
| |
| # Grouping the document tree into LaTeX files. List of tuples |
| # (source start file, target name, title, |
| # author, documentclass [howto, manual, or own class]). |
| latex_documents = [ |
| ('index', 'CloudStackReleaseNotes.tex', u'CloudStack Release Notes Documentation', |
| u'Apache CloudStack', 'manual'), |
| ] |
| |
| # The name of an image file (relative to this directory) to place at the top of |
| # the title page. |
| #latex_logo = None |
| |
| # For "manual" documents, if this is true, then toplevel headings are parts, |
| # not chapters. |
| #latex_use_parts = False |
| |
| # If true, show page references after internal links. |
| #latex_show_pagerefs = False |
| |
| # If true, show URL addresses after external links. |
| #latex_show_urls = False |
| |
| # Documents to append as an appendix to all manuals. |
| #latex_appendices = [] |
| |
| # If false, no module index is generated. |
| #latex_domain_indices = True |
| |
| |
| # -- Options for manual page output --------------------------------------- |
| |
| # One entry per manual page. List of tuples |
| # (source start file, name, description, authors, manual section). |
| man_pages = [ |
| ('index', 'cloudstackreleasenotes', u'CloudStack Release Notes Documentation', |
| [u'Apache CloudStack'], 1) |
| ] |
| |
| # If true, show URL addresses after external links. |
| #man_show_urls = False |
| |
| |
| # -- Options for Texinfo output ------------------------------------------- |
| |
| # Grouping the document tree into Texinfo files. List of tuples |
| # (source start file, target name, title, author, |
| # dir menu entry, description, category) |
| texinfo_documents = [ |
| ('index', 'CloudStackReleaseNotes', u'CloudStack Release Notes Documentation', |
| u'Apache CloudStack', 'CloudStackReleaseNotes', 'One line description of project.', |
| 'Miscellaneous'), |
| ] |
| |
| # Documents to append as an appendix to all manuals. |
| #texinfo_appendices = [] |
| |
| # If false, no module index is generated. |
| #texinfo_domain_indices = True |
| |
| # How to display URL addresses: 'footnote', 'no', or 'inline'. |
| #texinfo_show_urls = 'footnote' |
| |
| # If true, do not generate a @detailmenu in the "Top" node's menu. |
| #texinfo_no_detailmenu = False |
| |
| |
| # -- Options for Epub output ---------------------------------------------- |
| |
| # Bibliographic Dublin Core info. |
| epub_title = u'CloudStack Release Notes' |
| epub_author = u'Apache CloudStack' |
| epub_publisher = u'Apache CloudStack' |
| epub_copyright = u'2016, Apache CloudStack' |
| |
| # The basename for the epub file. It defaults to the project name. |
| #epub_basename = u'CloudStack Release Notes' |
| |
| # The HTML theme for the epub output. Since the default themes are not optimized |
| # for small screen space, using the same theme for HTML and epub output is |
| # usually not wise. This defaults to 'epub', a theme designed to save visual |
| # space. |
| #epub_theme = 'epub' |
| |
| # The language of the text. It defaults to the language option |
| # or en if the language is not set. |
| #epub_language = '' |
| |
| # The scheme of the identifier. Typical schemes are ISBN or URL. |
| #epub_scheme = '' |
| |
| # The unique identifier of the text. This can be a ISBN number |
| # or the project homepage. |
| #epub_identifier = '' |
| |
| # A unique identification for the text. |
| #epub_uid = '' |
| |
| # A tuple containing the cover image and cover page html template filenames. |
| #epub_cover = () |
| |
| # A sequence of (type, uri, title) tuples for the guide element of content.opf. |
| #epub_guide = () |
| |
| # HTML files that should be inserted before the pages created by sphinx. |
| # The format is a list of tuples containing the path and title. |
| #epub_pre_files = [] |
| |
| # HTML files shat should be inserted after the pages created by sphinx. |
| # The format is a list of tuples containing the path and title. |
| #epub_post_files = [] |
| |
| # A list of files that should not be packed into the epub file. |
| #epub_exclude_files = [] |
| |
| # The depth of the table of contents in toc.ncx. |
| #epub_tocdepth = 3 |
| |
| # Allow duplicate toc entries. |
| #epub_tocdup = True |
| |
| # Choose between 'default' and 'includehidden'. |
| #epub_tocscope = 'default' |
| |
| # Fix unsupported image types using the PIL. |
| #epub_fix_images = False |
| |
| # Scale large images. |
| #epub_max_image_width = 0 |
| |
| # How to display URL addresses: 'footnote', 'no', or 'inline'. |
| #epub_show_urls = 'inline' |
| |
| # If false, no index is generated. |
| #epub_use_index = True |