openstack/openstack-manuals
Code Issues Proposed changes

User Guides: Enable translations

Browse Source 
openstack-doc-tools 0.28 contains a fix for translation of RST guides
and the User Guides. Require that version and enable the User Guides for
translation.

Add building of glossary for translation environments to tox.ini.

Change-Id: I645bf98b68603811a9a978e508d1f492e44da738
This commit is contained in:
Andreas Jaeger 2015-05-13 22:07:38 +02:00
parent fcb9af6e1a
commit f69c489346
3 changed files with 13 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
doc-tools-check-languages.conf
View File

@ -9,10 +9,7 @@ declare -A DIRECTORIES=(
# books to be built # books to be built
declare -A BOOKS=( declare -A BOOKS=(
["fr"]="image-guide" ["fr"]="image-guide"
# TODO(ajaeger) Temporary disabled user-guide and user-guide-admin. ["ja"]="image-guide install-guide user-guide user-guide-admin"
# This needs openstack-doc-tools 0.28 release first.
# ["ja"]="image-guide install-guide user-guide user-guide-admin"
["ja"]="image-guide install-guide"
["pt_BR"]="install-guide" ["pt_BR"]="install-guide"
["zh_CN"]="arch-design image-guide install-guide" ["zh_CN"]="arch-design image-guide install-guide"
) )
@ -20,10 +17,7 @@ declare -A BOOKS=(
# draft books # draft books
declare -A DRAFTS=( declare -A DRAFTS=(
["fr"]="image-guide" ["fr"]="image-guide"
# TODO(ajaeger) Temporary disabled user-guide and user-guide-admin. ["ja"]="install-guide user-guide user-guide-admin"
# This needs openstack-doc-tools 0.28 release first.
# ["ja"]="install-guide user-guide user-guide-admin"
["ja"]="install-guide"
["pt_BR"]="install-guide" ["pt_BR"]="install-guide"
["zh_CN"]="install-guide" ["zh_CN"]="install-guide"
) )
@ -38,9 +32,7 @@ DOC_DIR="doc/"
# Books with special handling # Books with special handling
# Values need to match content in project-config/jenkins/scripts/common_translation_update.sh # Values need to match content in project-config/jenkins/scripts/common_translation_update.sh
declare -A SPECIAL_BOOKS=( declare -A SPECIAL_BOOKS=(
# TODO(ajaeger) Temporary disabled user-guide and user-guide-admin. ["user-guide"]="RST"
# This needs openstack-doc-tools 0.28 release first. ["user-guide-admin"]="RST"
["user-guide"]="skip"
["user-guide-admin"]="skip"
["networking-guide"]="RST" ["networking-guide"]="RST"
) )

2
test-requirements.txt
View File

@ -8,7 +8,7 @@ hacking>=0.10.0,<0.11
beautifulsoup4 beautifulsoup4
Jinja2>=2.6 # BSD License (3 clause) Jinja2>=2.6 # BSD License (3 clause)
openstack-doc-tools>=0.27 openstack-doc-tools>=0.28
sphinx>=1.1.2,!=1.2.0,!=1.3b1,<1.3 sphinx>=1.1.2,!=1.2.0,!=1.3b1,<1.3
openstackdocstheme>=1.0.7 openstackdocstheme>=1.0.7
doc8 # Apache-2.0 doc8 # Apache-2.0

11
tox.ini
View File

@ -63,7 +63,9 @@ commands =
# use sitepackages. # use sitepackages.
sitepackages=True sitepackages=True
whitelist_externals = doc-tools-check-languages whitelist_externals = doc-tools-check-languages
commands = doc-tools-check-languages doc-tools-check-languages.conf test all commands =
{toxinidir}/tools/glossary2rst.py doc/common-rst/glossary.rst
doc-tools-check-languages doc-tools-check-languages.conf test all
[testenv:buildlang] [testenv:buildlang]
# Run as "tox -e buildlang -- $LANG" # Run as "tox -e buildlang -- $LANG"
@ -72,7 +74,9 @@ commands = doc-tools-check-languages doc-tools-check-languages.conf test all
# use sitepackages. # use sitepackages.
sitepackages=True sitepackages=True
whitelist_externals = doc-tools-check-languages whitelist_externals = doc-tools-check-languages
commands = doc-tools-check-languages doc-tools-check-languages.conf test {posargs} commands =
{toxinidir}/tools/glossary2rst.py doc/common-rst/glossary.rst
doc-tools-check-languages doc-tools-check-languages.conf test {posargs}
[testenv:publishlang] [testenv:publishlang]
# Generatedocbook needs xml2po which cannot be installed # Generatedocbook needs xml2po which cannot be installed
@ -81,7 +85,8 @@ commands = doc-tools-check-languages doc-tools-check-languages.conf test {posarg
sitepackages=True sitepackages=True
whitelist_externals = doc-tools-check-languages whitelist_externals = doc-tools-check-languages
commands = commands =
doc-tools-check-languages doc-tools-check-languages.conf publish all {toxinidir}/tools/glossary2rst.py doc/common-rst/glossary.rst
doc-tools-check-languages doc-tools-check-languages.conf publish all
[testenv:generatepot-rst] [testenv:generatepot-rst]
# Generate POT files for translation, needs {posargs} like: # Generate POT files for translation, needs {posargs} like: