diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..0a2a089 --- /dev/null +++ b/.gitignore @@ -0,0 +1 @@ +.tox/ \ No newline at end of file diff --git a/.zuul.yaml b/.zuul.yaml new file mode 100644 index 0000000..5c55f66 --- /dev/null +++ b/.zuul.yaml @@ -0,0 +1,4 @@ +--- +- project: + templates: + - publish-opendev-tox-docs diff --git a/doc/requirements.txt b/doc/requirements.txt new file mode 100644 index 0000000..af0b462 --- /dev/null +++ b/doc/requirements.txt @@ -0,0 +1,2 @@ +doc8 +sphinx diff --git a/doc/source/conf.py b/doc/source/conf.py new file mode 100644 index 0000000..99279bc --- /dev/null +++ b/doc/source/conf.py @@ -0,0 +1,3 @@ +project = 'VEXXHOST Documentation' +copyright = '2020, VEXXHOST, Inc.' +author = 'VEXXHOST, Inc.' \ No newline at end of file diff --git a/doc/source/index.rst b/doc/source/index.rst new file mode 100644 index 0000000..741e208 --- /dev/null +++ b/doc/source/index.rst @@ -0,0 +1,2 @@ +VEXXHOST Documentation +====================== diff --git a/test-requirements.txt b/test-requirements.txt new file mode 100644 index 0000000..939f75f --- /dev/null +++ b/test-requirements.txt @@ -0,0 +1 @@ +stestr diff --git a/tox.ini b/tox.ini new file mode 100644 index 0000000..ad9aa55 --- /dev/null +++ b/tox.ini @@ -0,0 +1,26 @@ +[tox] +minversion = 3.1.1 +envlist = docs +skipsdist = True + +[testenv] +basepython = python3 +usedevelop = False +passenv = + OS_* +deps = + -rtest-requirements.txt +commands = + stestr run {posargs} + stestr slowest + +[doc8] +# Settings for doc8: +extensions = .rst + +[testenv:docs] +deps = + -r{toxinidir}/doc/requirements.txt +commands = + doc8 doc/source + sphinx-build -W --keep-going -b html -d doc/build/doctrees doc/source doc/build/html