* Make external links translatable.
If we use a separate-style of external links, link labels cannot be
translated, as they are used as label IDs.
* The new openstackdocstheme add version number on the left-top corner.
However, I18n project has no release, so the version, so the version
number has no meaning. There is no need to specify 'version' in
doc/source/conf.py.
Change-Id: I92c91bc39a079be2833a22527683b9c8bc477324
The new way of configuring html_context was introduced
in openstackdocstheme 1.11.0.
It is much simpler and most projects adopt it now.
Note that the current openstackdocstheme does not declare if it is
safe for parallel reading, so -j 2 or larget int does not work.
Let's drop -j option as the doc build is fast enough.
Change-Id: If1918b0101abf93aa55d4abe3c91a13bb0fe83d1
This patch proposes to publish translated I18n contributor guide(s)
using publishdocs tox job.
It assumes that the URL structure of translated guides would follow
https://docs.openstack.org/developer/i18n/[language-code] scheme.
publishdocs tox job first executes docs job
which builds the original guide, then it executes build-docs.sh
build-docs.sh shell script which outputs
translated I18n contributor guide(s) into [language-code] directory
from current docs job output directory.
Then it copies to publish-docs/developer/i18n directory including
translated guide(s). The directory will be synced through
infra jenkins job which is implemented later.
Note that specifying locale directory in conf.py is needed
to enable sphinx-build execution with locale files.
Implements: blueprint i18n-guide-translation
Co-Authored-By: Akihiro Motoki <amotoki@gmail.com>
Change-Id: Id117308190de56bf9a9c4eb712bda82dea6f9e51
This commit update the document theme. :)
The bug link points to openstack-i18n launchpad project
so that readers can report a bug against openstack-i18n project.
Co-Authored-By: Akihiro Motoki <amotoki@gmail.com>
Change-Id: I5356b5d0ba19acc5f6eb86b6e67fd9e5151167da
os.popen() is deprecated since version 2.6. Resolved with use of
subprocess module.
Change-Id: I261a2c6578b2f6a57a61bb672f38c6d9d6169c3f
Closes-Bug: #1529836
This commit adds tox.ini and define test targets.
Naming of tox targets follows OpenStack most projects:
- docs for document generation
For mainly a testing purpose, contributor-guide/source/index.rst
includes CONTRIBUTING.rst at the top level.
To generate the current doc, run "tox -e docs".
setup.py and setup.cfg are added because they are
required to publish the docs to docs.o.o.
Co-Authored-By: Akihiro Motoki <amotoki@gmail.com>
Implements: blueprint i18n-contributor-guide
Change-Id: Iaf3b09865ced8b30f987b68a07c2970d2b425708
