From d4fd23d60b9b3b2f931c4c691ea01199321fd7ad Mon Sep 17 00:00:00 2001 From: Dean Troyer Date: Wed, 18 Jul 2018 14:39:57 -0500 Subject: [PATCH] Update base with current OpenStack PTI config * rename docs to doc * adds conf.py * adds tox 'docs' environment and sphinx-build call * remove bashate from linters env * clean yaml lint error Change-Id: I9cbacea395b13554162f955ddb57e54365952f95 Signed-off-by: Dean Troyer --- doc/Makefile | 20 +++ doc/requirements.txt | 2 + {docs => doc}/setup.cfg | 4 +- {docs => doc}/setup.py | 0 doc/source/conf.py | 155 +++++++++++++++++++++++ {docs => doc}/source/contributing.rst | 0 {docs => doc}/source/getting_started.rst | 0 {docs => doc}/source/index.rst | 11 +- test-requirements.txt | 8 +- tox.ini | 8 ++ 10 files changed, 198 insertions(+), 10 deletions(-) create mode 100644 doc/Makefile create mode 100644 doc/requirements.txt rename {docs => doc}/setup.cfg (93%) rename {docs => doc}/setup.py (100%) create mode 100644 doc/source/conf.py rename {docs => doc}/source/contributing.rst (100%) rename {docs => doc}/source/getting_started.rst (100%) rename {docs => doc}/source/index.rst (66%) diff --git a/doc/Makefile b/doc/Makefile new file mode 100644 index 000000000..15c54f01c --- /dev/null +++ b/doc/Makefile @@ -0,0 +1,20 @@ +# Minimal makefile for Sphinx documentation +# + +# You can set these variables from the command line. +SPHINXOPTS = +SPHINXBUILD = sphinx-build +SPHINXPROJ = stx-docs +SOURCEDIR = source +BUILDDIR = build + +# Put it first so that "make" without argument is like "make help". +help: + @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) + +.PHONY: help Makefile + +# Catch-all target: route all unknown targets to Sphinx using the new +# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). +%: Makefile + @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) diff --git a/doc/requirements.txt b/doc/requirements.txt new file mode 100644 index 000000000..7d9ab5500 --- /dev/null +++ b/doc/requirements.txt @@ -0,0 +1,2 @@ +openstack-doc-tools>=1.6.0 +sphinx>=1.6.2 diff --git a/docs/setup.cfg b/doc/setup.cfg similarity index 93% rename from docs/setup.cfg rename to doc/setup.cfg index ea878a94b..d40424fbd 100644 --- a/docs/setup.cfg +++ b/doc/setup.cfg @@ -1,5 +1,5 @@ [metadata] -name = starlingxdocs +name = stx-docs summary = StarlingX Documentation author = StarlingX author-email = starlingx-discuss@lists.starlingx.io @@ -27,4 +27,4 @@ source-dir = source universal = 1 [pbr] -warnerrors = True \ No newline at end of file +warnerrors = True diff --git a/docs/setup.py b/doc/setup.py similarity index 100% rename from docs/setup.py rename to doc/setup.py diff --git a/doc/source/conf.py b/doc/source/conf.py new file mode 100644 index 000000000..e6b2325b5 --- /dev/null +++ b/doc/source/conf.py @@ -0,0 +1,155 @@ +# -*- 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('.')) + + +# -- Project information ----------------------------------------------------- + +project = 'stx-docs' +copyright = '2018, StarlingX' +author = 'StarlingX' + +# The short X.Y version +version = '' +# The full version, including alpha/beta/rc tags +release = '' + + +# -- 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 = [ +] + +# 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 = None + +# 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 = 'sphinx' + + +# -- 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 = 'alabaster' + +# 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 = {} + +# 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'] + +# 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'), +] diff --git a/docs/source/contributing.rst b/doc/source/contributing.rst similarity index 100% rename from docs/source/contributing.rst rename to doc/source/contributing.rst diff --git a/docs/source/getting_started.rst b/doc/source/getting_started.rst similarity index 100% rename from docs/source/getting_started.rst rename to doc/source/getting_started.rst diff --git a/docs/source/index.rst b/doc/source/index.rst similarity index 66% rename from docs/source/index.rst rename to doc/source/index.rst index f79c30e73..055bf060e 100644 --- a/docs/source/index.rst +++ b/doc/source/index.rst @@ -3,15 +3,22 @@ StarlingX Documentation ======================= Abstract -~~~~~~~~ +-------- This is the general documentation for the StarlingX project. Contents -~~~~~~~~ +-------- .. toctree:: :maxdepth: 2 + :caption: Contents: getting_started.rst contributing.rst + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`search` diff --git a/test-requirements.txt b/test-requirements.txt index cde66005e..266f880b8 100644 --- a/test-requirements.txt +++ b/test-requirements.txt @@ -1,6 +1,2 @@ -bashate >= 0.2 -PyYAML >= 3.1.0 -yamllint >= 0.5.2 -openstack-doc-tools>=1.6.0 -sphinx>=1.6.2 -openstackdocstheme>=1.18.1 +PyYAML>=3.1.0 +yamllint>=0.5.2 diff --git a/tox.ini b/tox.ini index 8303f125f..4a2cc0053 100644 --- a/tox.ini +++ b/tox.ini @@ -12,6 +12,14 @@ setenv = VIRTUAL_ENV={envdir} OS_TEST_TIMEOUT=60 deps = -r{toxinidir}/test-requirements.txt +[testenv:docs] +basepython = python3 +deps = + -c{env:UPPER_CONSTRAINTS_FILE:https://git.openstack.org/cgit/openstack/requirements/plain/upper-constraints.txt} + -r{toxinidir}/doc/requirements.txt +commands = + sphinx-build -a -E -W -d doc/build/doctrees -b html doc/source doc/build/html + [testenv:linters] whitelist_externals = bash commands =