
This is a fairly opinionated change to do some spring cleaning on the documentation. The current output of shocco as rendered at [1] is completely broken. I can not see that it is worth us maintaining this. Honestly, the github page does a better job at showing the scripts with a bit of formatting. The "changes" page is similarly useless today. cgit or github show allow browsing of changes in the repo better. Both are removed along with support scripts. When you currently hit the first page, it gives no clue as to what DevStack actually is. Add a paragraph explaining that, and link to the cgit for easy source browsing. stackrc.rst is not necessary; the stuff about database backends is already discussed in configuration.rst; move the things about service repos into a section of configuration.rst. The discussion in openrc.rst is moved into the configuration.rst file. localrc.conf.rst was just a paragraph pointing back to configuration.rst; this is removed. The variables described in exercise.rst are moved into a separate section of configuration.rst [1] http://docs.openstack.org/developer/devstack/#scripts Change-Id: Ie7f4b265368f1d10a8908d75e11d625b2cc39e7c
52 lines
1.6 KiB
INI
52 lines
1.6 KiB
INI
[tox]
|
|
minversion = 1.6
|
|
skipsdist = True
|
|
envlist = bashate
|
|
|
|
[testenv]
|
|
usedevelop = False
|
|
install_command = pip install {opts} {packages}
|
|
|
|
[testenv:bashate]
|
|
# if you want to test out some changes you have made to bashate
|
|
# against devstack, just set BASHATE_INSTALL_PATH=/path/... to your
|
|
# modified bashate tree
|
|
deps =
|
|
{env:BASHATE_INSTALL_PATH:bashate==0.5.0}
|
|
whitelist_externals = bash
|
|
commands = bash -c "find {toxinidir} \
|
|
-not \( -type d -name .?\* -prune \) \
|
|
-not \( -type d -name doc -prune \) \
|
|
-not \( -type f -name localrc -prune \) \
|
|
-type f \
|
|
-not -name \*~ \
|
|
-not -name \*.md \
|
|
-not -name stack-screenrc \
|
|
-not -name \*.orig \
|
|
-not -name \*.rej \
|
|
\( \
|
|
-name \*.sh -or \
|
|
-name \*rc -or \
|
|
-name functions\* -or \
|
|
-wholename \*/inc/\* -or \
|
|
-wholename \*/lib/\* \
|
|
\) \
|
|
-print0 | xargs -0 bashate -v -iE006 -eE005,E042"
|
|
|
|
[testenv:docs]
|
|
deps =
|
|
Pygments
|
|
docutils
|
|
sphinx>=1.1.2,<1.2
|
|
pbr>=0.6,!=0.7,<1.0
|
|
oslosphinx
|
|
nwdiag
|
|
blockdiag
|
|
sphinxcontrib-blockdiag
|
|
sphinxcontrib-nwdiag
|
|
whitelist_externals = bash
|
|
setenv =
|
|
TOP_DIR={toxinidir}
|
|
commands =
|
|
python setup.py build_sphinx
|