Update tox -edocs settings
Clean up our README.rst file and use variables right from defaults/main.yaml. This will ensure they are always up to date. Change-Id: If2f8bf5b04491f54590f840cbaa98f2d67faf8d0 Signed-off-by: Paul Belanger <pabelanger@redhat.com>
This commit is contained in:
parent
8636c62f6f
commit
9105363441
15
README.rst
15
README.rst
@ -35,19 +35,10 @@ creating DIBs.
|
||||
Role Variables
|
||||
--------------
|
||||
|
||||
.. code-block:: yaml
|
||||
|
||||
# Name of the user to be created.
|
||||
# Default: nodepool
|
||||
nodepool_user_name: nodepool
|
||||
|
||||
# Name of the group to be created.
|
||||
# Default: nodepool
|
||||
nodepool_user_group: nodepool
|
||||
|
||||
# Path of home directory to be created.
|
||||
# Default: /var/lib/nodepool
|
||||
nodepool_user_home: /var/lib/nodepool
|
||||
.. literalinclude:: ../../defaults/main.yaml
|
||||
:language: yaml
|
||||
:start-after: under the License.
|
||||
|
||||
Dependencies
|
||||
------------
|
||||
|
7
doc/requirements.txt
Normal file
7
doc/requirements.txt
Normal file
@ -0,0 +1,7 @@
|
||||
# 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.
|
||||
|
||||
# this is required for the docs build jobs
|
||||
sphinx!=1.6.6,!=1.6.7,>=1.6.2 # BSD
|
||||
doc8>=0.6.0 # Apache-2.0
|
@ -1,3 +1,2 @@
|
||||
ansible-lint
|
||||
hacking<0.11,>=0.10
|
||||
sphinx>=1.1.2,!=1.2.0,!=1.3b1,<1.3
|
||||
|
8
tox.ini
8
tox.ini
@ -19,7 +19,13 @@ setenv =
|
||||
PYTHONUNBUFFERED = 1
|
||||
|
||||
[testenv:docs]
|
||||
commands = python setup.py build_sphinx
|
||||
deps = -r{toxinidir}/doc/requirements.txt
|
||||
whitelist_externals =
|
||||
bash
|
||||
commands=
|
||||
bash -c "rm -rf doc/build"
|
||||
doc8 doc
|
||||
sphinx-build -b html doc/source doc/build/html
|
||||
|
||||
[testenv:venv]
|
||||
commands = {posargs}
|
||||
|
Loading…
Reference in New Issue
Block a user