From 9381a985a2e71ca685935b8a6e0b34d2a5dcf4f7 Mon Sep 17 00:00:00 2001 From: Thanh Ha Date: Tue, 24 Apr 2018 11:18:45 -0400 Subject: [PATCH] Bootstrap common-packer RTD documentation Issue: RELENG-513 Change-Id: Ic199def610eea4daa3d07713e54e373258bec815 Signed-off-by: Thanh Ha --- .gitignore | 1 + docs/_static/logo.png | Bin 0 -> 558 bytes docs/conf.py | 21 +++++++++++++++++++++ docs/conf.yaml | 3 +++ docs/favicon.ico | Bin 0 -> 2462 bytes docs/index.rst | 16 ++++++++++++++++ docs/requirements.txt | 1 + tox.ini | 10 ++++++++++ 8 files changed, 52 insertions(+) create mode 100644 docs/_static/logo.png create mode 100644 docs/conf.py create mode 100644 docs/conf.yaml create mode 100644 docs/favicon.ico create mode 100644 docs/index.rst create mode 100644 docs/requirements.txt 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 0000000000000000000000000000000000000000..0796dacfe552b5f77594ae4058ce6f8d72cd8f06 GIT binary patch literal 558 zcmV+}0@3}6P)e7N_V^Zk-@4&4Ywm!fMR-Fh%qjJ5w-sgzcn0Wwx< ztLwA16;JDql+>89;i2K`V3XAfva_|77cXBU3;-Z+1_S_T#CSe+_j)-41i;f8VSq4T zCe6yV!3bo;inzbYc|8&lqy~XER4I?&zZs|I6v+4VTy1sv`<6YU*-SKWrF7$VrF1EL zJU;Sday0X2&tA=}t^cqtALMB@@!-zA>Q%*jx!9A}<~T9#?C}ezZVHPH3KUgC-GA;q zGU7gN96p`j?klM2Tg8$7;QX8ID=PZj>vKWz#n)Ok$XB@qfv>5fX#WVnh@0PxfSu%c z?IJ6WD!qeV^mgv^`^9Br1=I-yf;g=0#NT$4=H0JEuJwhb!r_|_pO(IEfT_caQo&K` z0KrL_?I#jjXGQi78aOzDr_qR0b3#DWv|8)%WjkJ|M_yas66+q8dj@p$ZegkZbB~$Z wZG>7q+d3G@whzt3aH+9!oPWyL=>IkU-%;AVxx0fi<^TWy07*qoM6N<$g8k?SlK=n! literal 0 HcmV?d00001 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 0000000000000000000000000000000000000000..fc9eadbebd56765d84a3e79a32c69e9113c4c3e6 GIT binary patch literal 2462 zcmeHJ&nts*9R4DcTt~a%peV*gYw-{G2Uf(z?}Jj5Qp%57bC66jMI#3xxkygCElQ!a z+JTvaB+ar=X6Ai-pO@5X+xxz9=ktBP&+{}P^5n;25%Rl2Ocx7LCWNS# zkV~RLg6r7||7GkAC@CnZL{7+uP!t7k$yX#_U%v64dduBQ{w{HMg7}#m@xWq6JewAuwFl3WtyF$FH@PFr<%q0Q;>uf;|Cbw4YER3MPxdUbJfY`1r7y?ZYO(De#>UJ*Mr^x>Fxg(O+h63T2bm}I ze2+aJ{Y@tHH5FzApK*`gd>}t_kXgkZDx@#z&8+y^rzhW-t;|^V;5m#yPd@W9*@Nf! T336q>rcnOqhHU?ferx>$BV*m= literal 0 HcmV?d00001 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 -- 2.16.6