From 18287939629639aba767dfeffa0055826182d3ae Mon Sep 17 00:00:00 2001 From: Roman Gorshunov Date: Tue, 2 Jul 2019 13:03:13 +0200 Subject: [PATCH] Add gate for docs build Change-Id: Ib5707c9068fb59d25872a09316aea27f60139296 --- .readthedocs.yaml | 23 +++++ .zuul.yaml | 24 +++-- Makefile | 52 +++++++++++ doc/requirements.txt | 4 + doc/source/_static/.gitkeep | 0 doc/source/conf.py | 178 +++++++++++++++++------------------- requirements.txt | 9 -- setup.cfg | 26 ------ setup.py | 29 ------ test-requirements.txt | 11 --- tox.ini | 28 ++---- 11 files changed, 190 insertions(+), 194 deletions(-) create mode 100644 .readthedocs.yaml create mode 100644 Makefile create mode 100644 doc/requirements.txt create mode 100644 doc/source/_static/.gitkeep delete mode 100644 requirements.txt delete mode 100644 setup.cfg delete mode 100644 setup.py delete mode 100644 test-requirements.txt diff --git a/.readthedocs.yaml b/.readthedocs.yaml new file mode 100644 index 0000000..6ebbaa3 --- /dev/null +++ b/.readthedocs.yaml @@ -0,0 +1,23 @@ +# .readthedocs.yml +# Read the Docs configuration file +# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details + +# Required +version: 2 + +# Build documentation in the docs/ directory with Sphinx +sphinx: + configuration: doc/conf.py + +# Build documentation with MkDocs +#mkdocs: +# configuration: mkdocs.yml + +# Optionally build your docs in additional formats such as PDF and ePub +formats: PDF + +# Optionally set the version of Python and requirements required to build your docs +python: + version: 3.7 + install: + - requirements: doc/requirements.txt diff --git a/.zuul.yaml b/.zuul.yaml index ed78a36..05a6a96 100644 --- a/.zuul.yaml +++ b/.zuul.yaml @@ -1,8 +1,18 @@ -- project: - check: - jobs: - - noop - gate: - jobs: - - noop +# Licensed 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. +- project: + templates: + - docs-on-readthedocs + vars: + rtd_webhook_id: '90677' + rtd_project_name: 'airship-election' diff --git a/Makefile b/Makefile new file mode 100644 index 0000000..59cf69a --- /dev/null +++ b/Makefile @@ -0,0 +1,52 @@ +# Copyright 2019 AT&T Intellectual Property. All other rights reserved. +# +# Licensed 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. + +# VERSION INFO +GIT_COMMIT = $(shell git rev-parse HEAD) +GIT_SHA = $(shell git rev-parse --short HEAD) +GIT_TAG = $(shell git describe --tags --abbrev=0 --exact-match 2>/dev/null) +GIT_DIRTY = $(shell test -n "`git status --porcelain`" && echo "dirty" || echo "clean") + +SHELL = /bin/bash + +info: + @echo "Git Tag: ${GIT_TAG}" + @echo "Git Commit: ${GIT_COMMIT}" + @echo "Git Tree State: ${GIT_DIRTY}" + +.PHONY: all +all: docs + +.PHONY: check-tox +check-tox: + @if [ -z $$(which tox) ]; then \ + echo "Missing \`tox\` client which is required for development"; \ + exit 2; \ + fi + +.PHONY: docs +docs: clean build_docs + +.PHONY: build_docs +build_docs: + tox -e docs + +.PHONY: clean +clean: + rm -rf doc/build + +# testing checks +.PHONY: tests +tests: check-tox + tox diff --git a/doc/requirements.txt b/doc/requirements.txt new file mode 100644 index 0000000..63c3ed2 --- /dev/null +++ b/doc/requirements.txt @@ -0,0 +1,4 @@ +# The order of packages is significant, because pip processes them in the order +# of appearance. Changing the order has an impact on the overall integration +# process, which may cause wedges in the gate later. +sphinx_rtd_theme>=0.4.3 diff --git a/doc/source/_static/.gitkeep b/doc/source/_static/.gitkeep new file mode 100644 index 0000000..e69de29 diff --git a/doc/source/conf.py b/doc/source/conf.py index 3e9e67b..7a57de0 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -1,9 +1,11 @@ +#!/usr/bin/env python3 # -*- coding: utf-8 -*- # -# Tempest documentation build configuration file, created by -# sphinx-quickstart on Tue May 21 17:43:32 2013. +# Airship Project documentation build configuration file, created by +# sphinx-quickstart on Thu Jun 27 09:53:03 2019. # -# This file is execfile()d with the current directory set to its containing dir. +# 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. @@ -11,38 +13,30 @@ # All configuration values have a default; values that are commented out # serve to show the default. -import subprocess import sys import os # 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.join(os.path.abspath('.'), '_exts')) +#sys.path.insert(0, os.path.abspath('.')) -# -- General configuration ----------------------------------------------------- +# -- 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.extlinks', - 'openstackdocstheme', -] - -todo_include_todos = True - -# Define shorthand roles for making links to common destinations. -extlinks = { - 'repo': ('https://git.opendev.org/cgit/%s', ''), -} +# Add any Sphinx extension module names here, as strings. They can be +# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom +# ones. +extensions = [] # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates'] -# The suffix of source filenames. +# 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. @@ -52,12 +46,25 @@ source_suffix = '.rst' master_doc = 'index' # General information about the project. -project = u'Airship Election' -copyright = u'2019, Airship' +project = 'Airship Project' +copyright = '2019, Airship Team' +author = 'Airship Team' + +# 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.0.1' +# The full version, including alpha/beta/rc tags. +release = '0.0.1' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. -#language = None +# +# 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: @@ -67,10 +74,10 @@ copyright = u'2019, Airship' # List of patterns, relative to source directory, that match files and # directories to ignore when looking for source files. -exclude_patterns = ['_build', - ] +exclude_patterns = ['_build'] -# The reST default role (used for this markup: `text`) to use for all documents. +# 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. @@ -78,39 +85,44 @@ exclude_patterns = ['_build', # If true, the current module name will be prepended to all description # unit titles (such as .. function::). -add_module_names = False +#add_module_names = True # If true, sectionauthor and moduleauthor directives will be shown in the # output. They are ignored by default. -show_authors = False +#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 = [] +#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 = False -# -- Options for HTML output --------------------------------------------------- +# -- 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 = 'governance' +import sphinx_rtd_theme +html_theme = 'sphinx_rtd_theme' # 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 = { - 'display_global_toc_section': False, - 'root_title': 'Airship Governance' -} +#html_theme_options = {} # Add any paths that contain custom themes here, relative to this directory. -html_theme_path = ['_themes'] +#html_theme_path = [] +html_theme_path = [sphinx_rtd_theme.get_html_theme_path()] # The name for this set of Sphinx documents. If None, it defaults to # " v documentation". -html_title = 'Airship Governance' +#html_title = None # A shorter title for the navigation bar. Default is the same as html_title. #html_short_title = None @@ -119,21 +131,24 @@ html_title = 'Airship Governance' # of the sidebar. #html_logo = None -# 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 +# 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 = 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_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 '', a 'Last updated on:' timestamp is inserted at every page bottom, # using the given strftime format. -git_cmd = ["git", "log", "--pretty=format:'%ad, commit %h'", "--date=local", - "-n1"] -html_last_updated_fmt = subprocess.check_output(git_cmd).decode('utf-8') +#html_last_updated_fmt = '%b %d, %Y' # If true, SmartyPants will be used to convert quotes and dashes to # typographically correct entities. @@ -147,10 +162,10 @@ html_last_updated_fmt = subprocess.check_output(git_cmd).decode('utf-8') #html_additional_pages = {} # If false, no module index is generated. -html_domain_indices = False +#html_domain_indices = True # If false, no index is generated. -html_use_index = False +#html_use_index = True # If true, the index is split into individual pages for each letter. #html_split_index = False @@ -172,11 +187,24 @@ html_use_index = False # 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' +#html_search_language = 'en' + +# A dictionary with options for the search language support, empty by default. +# Now only 'ja' uses this config value +#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 = 'Tempestdoc' +htmlhelp_basename = 'AirshipGovernancedoc' - -# -- Options for LaTeX output -------------------------------------------------- +# -- Options for LaTeX output --------------------------------------------- latex_elements = { # The paper size ('letterpaper' or 'a4paper'). @@ -187,10 +215,14 @@ latex_elements = { # 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]). +# (source start file, target name, title, +# author, documentclass [howto, manual, or own class]). latex_documents = [ ('index', 'Governance.tex', 'Airship Governance Documents', u'Airship TC', 'manual'), @@ -217,7 +249,7 @@ latex_documents = [ #latex_domain_indices = True -# -- Options for manual page output -------------------------------------------- +# -- Options for manual page output --------------------------------------- # One entry per manual page. List of tuples # (source start file, name, description, authors, manual section). @@ -228,7 +260,7 @@ man_pages = [ #man_show_urls = False -# -- Options for Texinfo output ------------------------------------------------ +# -- Options for Texinfo output ------------------------------------------- # Grouping the document tree into Texinfo files. List of tuples # (source start file, target name, title, author, @@ -248,45 +280,5 @@ texinfo_documents = [ # How to display URL addresses: 'footnote', 'no', or 'inline'. #texinfo_show_urls = 'footnote' - -# -- Options for Epub output --------------------------------------------------- - -# Bibliographic Dublin Core info. -epub_title = u'Airship Election' -epub_author = u'Airship Election Officials' -epub_publisher = u'Airship' -epub_copyright = u'2019, Airship' - -# 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 = () - -# 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 +# If true, do not generate a @detailmenu in the "Top" node's menu. +#texinfo_no_detailmenu = False diff --git a/requirements.txt b/requirements.txt deleted file mode 100644 index 75dca40..0000000 --- a/requirements.txt +++ /dev/null @@ -1,9 +0,0 @@ -# The order of packages is significant, because pip processes them in the order -# of appearance. Changing the order has an impact on the overall integration -# process, which may cause wedges in the gate later. -six>=1.9.0 # MIT -requests>=2.14.2 # Apache-2.0 -ndg-httpsclient>=0.4.2;python_version<'3.0' # BSD -PrettyTable<0.8,>=0.7.1 # BSD -docutils>=0.11 # OSI-Approved Open Source, Public Domain -Jinja2>=2.10 # BSD License (3 clause) diff --git a/setup.cfg b/setup.cfg deleted file mode 100644 index dff4adc..0000000 --- a/setup.cfg +++ /dev/null @@ -1,26 +0,0 @@ -[metadata] -name = airship-election -summary = Airship Election Documents -description-file = README.rst -author = Airship Election Officials -author-email = airship-discuss@lists.openstack.org -home-page = https://opendev.org/airship/election/ -classifier = - Environment :: Airship - Intended Audience :: Information Technology - Intended Audience :: System Administrators - License :: OSI Approved :: Apache Software License - Operating System :: POSIX :: Linux - Programming Language :: Python - Programming Language :: Python :: 3 - Programming Language :: Python :: 3.5 - Programming Language :: Python :: 3.6 - -[build_sphinx] -all_files = 1 -build-dir = doc/build -source-dir = doc/source -builders = html - -[pbr] -warnerrors = True diff --git a/setup.py b/setup.py deleted file mode 100644 index 566d844..0000000 --- a/setup.py +++ /dev/null @@ -1,29 +0,0 @@ -# Copyright (c) 2013 Hewlett-Packard Development Company, L.P. -# -# Licensed 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. - -# THIS FILE IS MANAGED BY THE GLOBAL REQUIREMENTS REPO - DO NOT EDIT -import setuptools - -# In python < 2.7.4, a lazy loading of package `pbr` will break -# setuptools if some other modules registered functions in `atexit`. -# solution from: http://bugs.python.org/issue15881#msg170215 -try: - import multiprocessing # noqa -except ImportError: - pass - -setuptools.setup( - setup_requires=['pbr>=2.0.0'], - pbr=True) diff --git a/test-requirements.txt b/test-requirements.txt deleted file mode 100644 index ca20b40..0000000 --- a/test-requirements.txt +++ /dev/null @@ -1,11 +0,0 @@ -# The order of packages is significant, because pip processes them in the order -# of appearance. Changing the order has an impact on the overall integration -# process, which may cause wedges in the gate later. -# needed for doc build -sphinx>=1.6.2 # BSD -openstackdocstheme>=1.25.1 # Apache-2.0 -hacking<0.12,>=0.11.0 # Apache-2.0 -oslotest>=1.10.0 # Apache-2.0 -stestr>=2.0.0 # Apache-2.0 -testresources>=2.0.0 # Apache-2.0/BSD -fixtures>=3.0.0 # Apache-2.0/BSD diff --git a/tox.ini b/tox.ini index 7f97b58..cd2bce5 100644 --- a/tox.ini +++ b/tox.ini @@ -1,25 +1,15 @@ [tox] -envlist = docs,py35,py27 -minversion = 2.0 skipsdist = True +envlist = docs [testenv] -basepython = python3 -usedevelop = True -install_command = pip install -U {opts} {packages} -setenv = VIRTUAL_ENV={envdir} -deps = -r{toxinidir}/requirements.txt - -r{toxinidir}/test-requirements.txt -# NOTE: If py35 fails with "db type could not be determined", delete -# .testrepository and try again. Running py35 before py27 is OK, but not the -# other way around. See: https://bugs.launchpad.net/testrepository/+bug/1212909 -commands = stestr run --slowest {posargs} - -[testenv:venv] -commands = {posargs} +passenv=HTTP_PROXY HTTPS_PROXY http_proxy https_proxy NO_PROXY no_proxy +whitelist_externals = + rm [testenv:docs] -commands = sphinx-build -v -W -b html -d doc/build/doctrees doc/source doc/build/html - -[flake8] -exclude=.tox,doc/source/conf.py +basepython = python3 +deps = -r{toxinidir}/doc/requirements.txt +commands = + rm -rf doc/build + sphinx-build -W -b html doc/source doc/build/html