From: Thanh Ha Date: Tue, 24 Apr 2018 15:18:45 +0000 (-0400) Subject: Bootstrap common-packer RTD documentation X-Git-Tag: v0.1.0~39 X-Git-Url: https://gerrit.linuxfoundation.org/infra/gitweb?a=commitdiff_plain;h=refs%2Fchanges%2F02%2F10202%2F2;p=releng%2Fcommon-packer.git Bootstrap common-packer RTD documentation Issue: RELENG-513 Change-Id: Ic199def610eea4daa3d07713e54e373258bec815 Signed-off-by: Thanh Ha --- diff --git a/.gitignore b/.gitignore index c63ecaf..11bb7e3 100644 --- a/.gitignore +++ b/.gitignore @@ -1,4 +1,5 @@ .galaxy/ .tox/ +docs/_build/ cloud-env.json *.retry diff --git a/docs/_static/logo.png b/docs/_static/logo.png new file mode 100644 index 0000000..0796dac Binary files /dev/null and b/docs/_static/logo.png differ diff --git a/docs/conf.py b/docs/conf.py new file mode 100644 index 0000000..62617af --- /dev/null +++ b/docs/conf.py @@ -0,0 +1,21 @@ +#!/usr/bin/env python3 +# -*- coding: utf-8 -*- +# +# Linux Foundation Release Engineering Tools documentation build configuration file, created by +# sphinx-quickstart on Sat Mar 4 12:20:05 2017. +# +# 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. +# +# All configuration values have a default; values that are commented out +# serve to show the default. + +# 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. +# + +from docs_conf.conf import * diff --git a/docs/conf.yaml b/docs/conf.yaml new file mode 100644 index 0000000..ed1f82c --- /dev/null +++ b/docs/conf.yaml @@ -0,0 +1,3 @@ +--- +project: lf-common-packer +project_cfg: lfdocs diff --git a/docs/favicon.ico b/docs/favicon.ico new file mode 100644 index 0000000..fc9eadb Binary files /dev/null and b/docs/favicon.ico differ diff --git a/docs/index.rst b/docs/index.rst new file mode 100644 index 0000000..2693120 --- /dev/null +++ b/docs/index.rst @@ -0,0 +1,16 @@ +LF Common Packer +================ + +A collection of common packer scripts and baseline used by several Linux +Foundation projects. It is used as a central way to maintain and manage common +VM configuration. + +.. toctree:: + :maxdepth: 1 + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` diff --git a/docs/requirements.txt b/docs/requirements.txt new file mode 100644 index 0000000..74a3b7a --- /dev/null +++ b/docs/requirements.txt @@ -0,0 +1 @@ +lfdocs-conf diff --git a/tox.ini b/tox.ini index b3e34b8..1693fe6 100644 --- a/tox.ini +++ b/tox.ini @@ -16,3 +16,13 @@ commands = python3 -m nltk.downloader punkt maxent_treebank_pos_tagger averaged_perceptron_tagger coala --non-interactive +[testenv:docs] +deps = -rdocs/requirements.txt +commands = + sphinx-build -W -b html -n -W -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/html + echo "Generated docs available in {toxinidir}/docs/_build/html" +whitelist_externals = echo + +[testenv:docs-linkcheck] +deps = -rrequirements.txt +commands = sphinx-build -W -b linkcheck -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/linkcheck