Commit Graph

20 Commits

Author SHA1 Message Date
Andreas Jaeger
ed100316b4 Convert glossary to RST
We do not need the DocBook XML glossary anymore, since we do not build
any DocBook guides that use it.

Add instead the RST version of the document to git.
Adjust scripts to not build or publish the glossary anymore.

Change-Id: Id4bfef7666690e6d08291f664751db7a4d4d5983
2016-05-02 09:20:30 +02:00
KATO Tomoyuki
f6ce6bd328 Rename common-rst to common
Keep the sync target repo path "common-rst" as of now.

Change-Id: I552d2c0a422c4824632b11fa273629004b889306
2016-02-11 21:18:59 +09:00
Akihiro Motoki
61b9f5a221 generatepot-rst: dedicate logic to generate common-rst.pot
Previously common-rst.pot is additive only and
deleted strings in the source document will remain forever.
This commit make generatepot-rst.sh not reuse existing
common-rst.pot and generate the POT file from scratch.

This patch creates an index rst file which includes all
files under common-rst and generate common-rst.pot.
By doing so, all contents of common-rst can be covered.

Closes-Bug: #1507138
Change-Id: I888f37ad5e14a0e1cc7d182e376acaf63f98e565
2015-10-19 01:55:23 +09:00
Christian Berendt
63b0c3d638 Build in parallel with NUMBER_OF_CORES processes
Change-Id: Iffbdcd4fac12c2e39e3a887a2e7c4e32555d98bf
2015-10-14 12:33:52 +09:00
Andreas Jaeger
84eaa62fee Fix generatepot-rst for api-quick-start
The guide has no common directory, therefore we have no common
translation. Handle this  in our script.

Change-Id: If140cd8ebe893eedebd2a5f883210309380220e7
Depends-On: Id34b92430ef4da804335714710547ada02c23cef
2015-10-08 10:43:22 +02:00
Andreas Jaeger
34823b69ff Enhance generatepot-rst for reuse
Enhance file so that it can be used by other documentation repos as
well.
Update invocation of it.

Change-Id: I93a6d8ccb8c314c0961b87a239462183712cdd26
2015-10-06 20:11:17 +02:00
Akihiro Motoki
9ce3fc5efa Output strings in POT files in the order of file locaiton
Keeping the order of strings same as in the original source document
helps translators find the sources and they can translate by checking
rendered contents :-)

Note that Zanata keeps the order of strings in uploaded POT files.

Change-Id: I3ecd0516047050b94e8eba902620a4f40dc8fd36
Closes-Bug: #1503266
2015-10-06 22:02:56 +09:00
Andreas Jaeger
cfe63e2cf6 Install Guide: Include tagged content for translation
Enhance script so that content for all tags is generated and
send to our translation server.

Change-Id: I95a1e1661222cbba580e5f78837b40966ca03652
2015-08-22 14:53:35 +02:00
Andreas Jaeger
b11e9ef8cc Translate common-rst separately
To ease translation, translate common-rst in a separate po file.
Since we reuse the file in all RST guides, this needs special handling.

common-rst.pot is empty for now, we need the file so that the tools
work.

Change-Id: I9972e6222d4018b238da9b2b8f4e93e6ebc9e224
Co-Authored-By: KATO Tomoyuki <kato.tomoyuki@jp.fujitsu.com>
2015-06-17 16:52:30 +02:00
Andreas Jaeger
47c2f792ac Remove RST tags user_only and admin_only
These tags are now completely unused, remove them from scripts setting
them.

Now we can simplify publishdocs.sh with a simple loop instead of
separate invocations.

Remove our scope sphinx extensions, it's not needed anymore.
Remove also the hot extension from the Admin User Guide, it's only used
in the End User Guide.

Change-Id: Ib6c9f35e336ee13b84030a6e7164dea27d621e67
2015-05-13 18:09:39 +00:00
Andreas Jaeger
2e1b8d1d32 Move User Guides into separate directories
Separate User Guides cleanly, there's little benefit in having them in
one directory and it causes quite some strange sphinx challenges.

Temporarily disable translation of the guides since first a new release
of openstack-doc-tools is needed.

Partial implements bp reorganise-user-guides

Change-Id: I9e41bb67397c5bc26c1940f67387f3e42a9c5cbc
2015-05-12 11:56:08 +02:00
Andreas Jaeger
2dd2472967 Move RST Glossary to common-rst
Build glossary only once and put it into common-rst directory so that
all RST guides can use it.

Change-Id: I2d3acf25a3af48349b7c10b7e9fea86d5f16444e
2015-05-12 11:56:08 +02:00
Andreas Jaeger
209763c0b1 generatepot-rst: Fix to work with mawk
Ubuntu uses mawk by default which does not know about the regex feature
"{32}". Use "+" instead for a more portable regex.

Change-Id: I9fd52437eb332dedc9bf977173beda93f984843f
2015-04-16 14:30:23 +02:00
Andreas Jaeger
a8224a68b5 Add RST Glossary
Automatically convert the glossary from DocBook XML to RST with each
build and use it for building the RST guides.

Add the glossary to User Guides and Networking Guide.

Use glossary in User Guides in places where it was used before. This
removes one TODO.

Fix CORS capitalization.

Partial-Bug: #1421813
Change-Id: I3fba6d54b01759f39f8e1467a7606cdbd2dd0165
2015-04-14 19:57:35 +00:00
Andreas Jaeger
993647f316 Remove UUIDs from RST pot files
We do not need the UUIDs for our toolchain, remove them.

They cause huge changes with each import with no benefit for us.

Note: Sphinx 1.3 by default disables UUID generation but we're using an
older Sphinx version for building, thus have to do this manually.

Change-Id: I3f3e910c5b2a2d03a3f04b67015526c3b7e77ddb
2015-04-10 10:15:12 +02:00
Andreas Jaeger
5db746f9e8 User Guides: Rename playground-user-guide to user-guides
Move files to final place.

Change-Id: I3e88ce145f05daafb23c0516cd9da75a92b62e3c
2015-04-03 19:19:10 +02:00
Andreas Jaeger
efc7d3262a Include all strings for translations.
Building should not handle our tags, thus set *all* tags at once so that
all files get included in the po files.

Change-Id: I061988451543caea926cc60a3517203fc1807298
2015-04-03 08:06:25 +02:00
Andreas Jaeger
1b74d7ca0d Fix RST translation
Fix generatepot-rst.sh script to not generate duplicate messages and
properly delete generated files.

Let git ignore any python compiled files.

Change-Id: Ib0cb58980ba2bc751cfed9ad56942aedfb62d07e
2015-03-13 09:16:02 +01:00
Andreas Jaeger
0019bf4f07 Fix RST translation setup
Add missing $ to DOCNAME.
Remove doctrees directory.
Initial import of pot file.

Change-Id: Ie4171d6935e93281a627d8770b7aea97f58866e5
2015-03-09 16:40:40 +01:00
daisy-ycguo
670c7af1ad First step for translation of RST files
Set locale_dirs in conf.py to support translated documents building.
Add a config variable SPECIAL_BOOKS to list documents in RST format.
Add new generatepot-rst tox environment to generate all pot file,
invoke using "tox -e generatepot-rst -- playground-user-guide".

Add new script to generate the pot files.

Co-Authored-By: Andreas Jaeger <aj@suse.de>

Change-Id: I3124cf65b254c1c5aefce59447bb94240d96a742
2015-03-06 21:31:01 +01:00