From c1873360fa7455fdb690c6235923d7eb68e30ec6 Mon Sep 17 00:00:00 2001 From: Thanh Ha Date: Wed, 17 Jan 2018 15:23:26 -0500 Subject: [PATCH] Revert "Switch global-jjb to lfdocs-conf" Need to revert because conf.yaml causes deployment issues in jjb recursive runs as it's not expecting a non-jjb yaml. Let's not use lfdocs-conf in global-jjb until we have a way around that. This reverts commit ac79981ec42d37f943c2a4159e2980913cb1716d. Change-Id: I0eb5d269b31c76e5da7affd80d93715cee8e4037 Signed-off-by: Thanh Ha --- docs/conf.py | 238 ++++++++++++++++++++++++++++++++++++++++++++++++++++++- docs/conf.yaml | 12 --- requirements.txt | 5 +- 3 files changed, 241 insertions(+), 14 deletions(-) delete mode 100644 docs/conf.yaml diff --git a/docs/conf.py b/docs/conf.py index a9d7310d..2e0b16b2 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -22,4 +22,240 @@ import sys import sphinx_bootstrap_theme sys.path.insert(0, os.path.abspath('..')) -from docs_conf import * +# -- 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.doctest', + 'sphinx.ext.intersphinx', + 'sphinx.ext.todo', + 'sphinx.ext.coverage', + 'sphinx.ext.viewcode', + 'sphinxcontrib.programoutput', +] + +# 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 encoding of source files. +# +# source_encoding = 'utf-8-sig' + +# The master toctree document. +master_doc = 'index' + +# General information about the project. +project = 'lf-releng-global-jjb' +copyright = '2017, The Linux Foundation' +author = 'Linux Foundation Releng' + +# 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 = '0.15.0-dev' +# The full version, including alpha/beta/rc tags. +release = version + +# 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 = 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. +# This patterns also effect to html_static_path and html_extra_path +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 + +# If true, `todo` and `todoList` produce output, else they produce nothing. +todo_include_todos = True + + +# -- 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' + +# 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 = {} +html_theme_options = { + 'bootswatch_theme': "cerulean", + 'navbar_sidebarrel': False, + 'source_link_position': "footer", +} + +# Add any paths that contain custom themes here, relative to this directory. +# html_theme_path = [] +html_theme_path = sphinx_bootstrap_theme.get_html_theme_path() + +# The name for this set of Sphinx documents. +# " v documentation" by default. +# +# html_title = 'Linux Foundation Release Engineering Tools v0.0.1' + +# 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/lf-logo-small.png' + +# The name of an image file (relative to this directory) to use as a favicon of +# the docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 +# pixels large. +# +html_favicon = 'favicon.ico' + +# 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'] + +# 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 None, a 'Last updated on:' timestamp is inserted at every page +# bottom, using the given strftime format. +# The empty string is equivalent to '%b %d, %Y'. +# +# html_last_updated_fmt = None + +# 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 = { + '**': ['localtoc.html', 'relations.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 + +# 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 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 + +# Language to be used for generating the HTML full-text search index. +# Sphinx supports the following languages: +# 'da', 'de', 'en', 'es', 'fi', 'fr', 'h', 'it', 'ja' +# 'nl', 'no', 'pt', 'ro', 'r', 'sv', 'tr', 'zh' +# +# html_search_language = 'en' + +# A dictionary with options for the search language support, empty by default. +# 'ja' uses this config value. +# 'zh' user can custom change `jieba` dictionary path. +# +# html_search_options = {'type': 'default'} + +# The name of a javascript file (relative to the configuration directory) that +# implements a search results scorer. If empty, the default will be used. +# +# html_search_scorer = 'scorer.js' + +# Output file base name for HTML help builder. +htmlhelp_basename = 'LinuxFoundationReleaseEngineeringGJJBdoc' + +# Example configuration for intersphinx: refer to the Python standard library. +intersphinx_mapping = { + 'jjb': ('https://docs.openstack.org/infra/jenkins-job-builder/', None), + 'lftools': ('http://lftools.releng.linuxfoundation.org/en/latest/', None), + 'python': ('https://docs.python.org/', None), +} diff --git a/docs/conf.yaml b/docs/conf.yaml deleted file mode 100644 index f4247f66..00000000 --- a/docs/conf.yaml +++ /dev/null @@ -1,12 +0,0 @@ ---- -project: lf-releng-global-jjb -project_cfg: lfdocs -release: 0.15.0-dev -version: 0.15.0-dev -extensions: - - sphinx.ext.autodoc - - sphinx.ext.doctest - - sphinx.ext.intersphinx - - sphinx.ext.todo - - sphinx.ext.coverage - - sphinx.ext.viewcode diff --git a/requirements.txt b/requirements.txt index 74a3b7a3..5e1232c9 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1 +1,4 @@ -lfdocs-conf +sphinx>=1.6.4 +sphinxcontrib-programoutput +sphinx_bootstrap_theme>=0.6.0 + -- 2.16.6