User Guides: Fix titles for guides

Create titles for both guides to differentiate them.
This needs a separate top-level index file and some moving of files
around so that the finished guide has an index.html file.

Change-Id: Ibe23d0c466b5c5f7d0b909548b55f6c5382f8992
This commit is contained in:
Andreas Jaeger 2015-03-30 16:42:45 +02:00
parent 50fb12d06b
commit babd749f66
5 changed files with 53 additions and 12 deletions

@ -58,10 +58,18 @@ source_suffix = '.rst'
# source_encoding = 'utf-8-sig'
# The master toctree document.
master_doc = 'index'
# The master toctree document.
if tags.has('admin_only'): # noqa
master_doc = 'index-admin'
else:
master_doc = 'index'
# General information about the project.
project = u'User Guide'
if tags.has('admin_only'): # noqa
project = u'Admin User Guide'
else:
project = u'End User Guide'
copyright = u'2015, OpenStack contributors'
# The version info for the project you're documenting, acts as replacement for

@ -0,0 +1,19 @@
:orphan:
OpenStack Admin User Guide
==========================
Contents:
.. toctree::
:maxdepth: 2
dashboard.rst
cli.rst
Indices and tables
==================
* :ref:`genindex`
* :ref:`search`

@ -1,5 +1,9 @@
OpenStack User Guide
====================
:orphan:
OpenStack End User Guide
========================
This is the OpenStack End User Guide.
Contents:

12
tools/build-user-guides.sh Executable file

@ -0,0 +1,12 @@
#!/bin/sh -e
echo "Building End User Guide"
echo "======================="
sphinx-build -t user_only -E -W doc/playground-user-guide/source/ doc/playground-user-guide/build/html
echo "Building Admin User Guide"
echo "========================="
sphinx-build -t admin_only -E -W doc/playground-user-guide/source/ doc/playground-user-guide/build-admin/html
# Cleanup: Rename index-html to index everywhere
mv doc/playground-user-guide/build-admin/html/index-admin.html doc/playground-user-guide/build-admin/html/index.html
sed -i -e 's/index-admin.html/index.html/g' doc/playground-user-guide/build-admin/html/*.html doc/playground-user-guide/build-admin/html/*/*.html

14
tox.ini

@ -14,7 +14,6 @@ whitelist_externals =
mkdir
rm
rsync
sed
[testenv:venv]
commands = {posargs}
@ -44,12 +43,12 @@ commands =
python tools/www-generator.py --source-directory www/ --output-directory publish-docs/www/
cp www/www-index.html publish-docs/
rsync -a www/static/ publish-docs/www/
# Build RST playground-user-guide
sphinx-build -t user_only -E -W doc/playground-user-guide/source/ doc/playground-user-guide/build/html
# Build both RST User Guides
{toxinidir}/tools/build-user-guides.sh
# Copy RST playground-user-guide
mkdir -p publish-docs/playground-user-guide/content/
rsync -a doc/playground-user-guide/build/html/ publish-docs/playground-user-guide/content/
# Build RST user-guide-admin
sphinx-build -t admin_only -E -W doc/playground-user-guide/source/ doc/playground-user-guide/build-admin/html
# Copy RST user-guide-admincontent
mkdir -p publish-docs/playground-user-guide-admin/content/
rsync -a doc/playground-user-guide/build-admin/html/ publish-docs/playground-user-guide-admin/content/
# Build RST networking guide
@ -61,9 +60,8 @@ commands =
[testenv:docs]
commands =
sphinx-build -t user_only -E -W doc/playground-user-guide/source/ doc/playground-user-guide/build/html
sphinx-build -t admin_only -E -W doc/playground-user-guide/source/ doc/playground-user-guide/build-admin/html
sphinx-build -E -W doc/networking-guide/source doc/networking-guide/build/html
{toxinidir}/tools/build-user-guides.sh
sphinx-build -W doc/networking-guide/source doc/networking-guide/build/html
[testenv:network]
commands = sphinx-build -W doc/networking-guide/source doc/networking-guide/build/html