771536304a
This change updates the stale README and makes it the landing page of our new documentation. This change also makes several formatting changes to make our documentation fit the new docs.airshipit.org framework. Lastly, some items from the original README have been updated for accuracy and moved to a separate page of the documentation. Change-Id: Iae898b36034640df4d35a430eb28fbda028f10dd Signed-off-by: Drew Walters <andrew.walters@att.com>
67 lines
2.1 KiB
Python
67 lines
2.1 KiB
Python
# Configuration file for the Sphinx documentation builder.
|
|
#
|
|
# This file only contains a selection of the most common options. For a full
|
|
# list see the documentation:
|
|
# https://www.sphinx-doc.org/en/master/usage/configuration.html
|
|
|
|
# -- 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('.'))
|
|
import sphinx_rtd_theme
|
|
|
|
|
|
# -- Project information -----------------------------------------------------
|
|
|
|
project = 'airshipctl'
|
|
copyright = '2020, The Airship Authors'
|
|
author = 'The Airship Authors'
|
|
|
|
|
|
# -- General configuration ---------------------------------------------------
|
|
|
|
# Add any Sphinx extension module names here, as strings. They can be
|
|
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
|
|
# ones.
|
|
extensions = [
|
|
'recommonmark'
|
|
]
|
|
|
|
# Add any paths that contain templates here, relative to this directory.
|
|
templates_path = ['_templates']
|
|
|
|
# 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 = []
|
|
|
|
|
|
# -- Options for HTML output -------------------------------------------------
|
|
|
|
# The theme to use for HTML and HTML Help pages. See the documentation for
|
|
# a list of builtin themes.
|
|
#
|
|
html_logo = "img/airship.logo.white.svg"
|
|
html_theme = "sphinx_rtd_theme"
|
|
html_theme_options = {
|
|
'display_version': False,
|
|
'logo_only': True
|
|
}
|
|
html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
|
|
|
|
# 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']
|
|
|
|
# Source files
|
|
source_suffix = {
|
|
'.rst': 'restructuredtext',
|
|
'.md': 'markdown',
|
|
}
|