docs/doc/source/conf.py

# -*- coding: utf-8 -*-
#
# Configuration file for the Sphinx documentation builder.
#
# This file does only contain a selection of the most common options. For a
# full list see the documentation:
# http://www.sphinx-doc.org/en/master/config

# -- Path setup --------------------------------------------------------------

# 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.
#
import os
import sys
sys.path.insert(0,os.path.abspath('_themes'))
# sys.path.insert(0, os.path.abspath('.'))


# -- Project information -----------------------------------------------------

project = u'StarlingX'
copyright = '2018, StarlingX'
author = 'StarlingX'


# -- 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 = [
#    'openstackdocstheme',
     'starlingxdocs_plus'
]

if tags.has('use_spellext'):
    extensions.append('sphinxcontrib.spelling')
    spelling_word_list_filename='spelling_wordlist.txt'
    spelling_exclude_patterns=['developer_resources/Layered_Build_cn.rst']

# Add any paths that contain templates here, relative to this directory.
#templates_path = ['_templates']

# The suffix(es) of source filenames.
# You can specify multiple suffix as a list of string:
#
# source_suffix = ['.rst', '.md']
source_suffix = '.rst'

# The master toctree document.
master_doc = 'index'

# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
#
# This is also used if you do content translation via gettext catalogs.
# Usually you set "language" from the command line for these cases.
language = 'en'

# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
# This pattern also affects html_static_path and html_extra_path .
exclude_patterns = []

# The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'native'

# General information about the project.
# Legacy openstackdocstheme variables
# openstackdocs_repo_name = 'openstack/stx-docs'
# openstackdocs_project = 'StarlingX'
# openstackdocs_auto_name = False
# openstackdocs_bug_project = 'starlingx'
# openstackdocs_bug_tag = 'stx.docs'


# Common substitution strings such as organization, product
# and document names.
rst_prolog = open('./shared/strings.txt', 'r').read()


# -- 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_path = ['_themes']
html_theme = 'starlingxdocs_plus'

# Theme options are theme-specific and customize the look and feel of a theme
# further.  For a list of options available for each theme, see the
# documentation.
#
html_theme_options = {
    # MC testing
    "show_other_versions": "True",
    # ...
}


# 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']

# Edit supported HW table on load
html_js_files = [
#    'js/hw.js',
]

# Custom sidebar templates, must be a dictionary that maps document names
# to template names.
#
# The default sidebars (for documents that don't match any pattern) are
# defined by theme itself.  Builtin themes are using these templates by
# default: ``['localtoc.html', 'relations.html', 'sourcelink.html',
# 'searchbox.html']``.
#
# html_sidebars = {}


# -- Options for HTMLHelp output ---------------------------------------------

# Output file base name for HTML help builder.
htmlhelp_basename = 'stx-docsdoc'


# -- 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': '',

    # Latex figure (float) alignment
    #
    # 'figure_align': 'htbp',
}

# 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 = [
    (master_doc, 'stx-docs.tex', 'stx-docs Documentation',
     'StarlingX', 'manual'),
]


# -- Options for manual page output ------------------------------------------

# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
    (master_doc, 'stx-docs', 'stx-docs Documentation',
     [author], 1)
]


# -- 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 = [
    (master_doc, 'stx-docs', 'stx-docs Documentation',
     author, 'stx-docs', 'One line description of project.',
     'Miscellaneous'),
]

# -- Options for starlingxdocs_plus theme output -----------------------------
# General information about the project.

starlingxdocs_plus_repo_name = 'openstack/stx-docs'
starlingxdocs_plus_project = 'StarlingX'
starlingxdocs_plus_auto_name = False
starlingxdocs_plus_bug_project = 'starlingx'
starlingxdocs_plus_bug_tag = 'stx.docs'
starlingxdocs_plus_this_version = "Version 7.0"
# starlingxdocs_plus_other_versions = [("even later","even-later"),("sooner","sooner")]
starlingxdocs_plus_other_versions = [("Version 6.0","r/stx.6.0"),("Version 8.0","r/stx.8.0"),("Latest","")]