Commit Graph

98 Commits

Author SHA1 Message Date
Andreas Jaeger 8f7f1d97fe Cleanup doc-tools-check-languages
Remove now unused content.

Change-Id: I77f5b2927f4d455e34c55afc8e98b6533ac6f459
2019-08-15 20:35:40 +02:00
Andreas Jaeger a031fd772e Publish to publish-docs/html
Publish to publish-docs/html to simplify our doc building and publishing
CI jobs.

Change-Id: I8beb68195a7beaa3f2c125ef83db0fa589837639
2019-08-15 06:30:48 +02:00
Andreas Jaeger a178d4b73c Don't use special api-quick-start location
To simplify publishing of the guide, we don't use the special directory
anymore, remove it for translated documents as well.

Change-Id: I0520314f4946736b78e9d7438d676739c741f7b1
2019-07-23 13:38:28 +02:00
Ian Y. Choi bb24cc4ec5 [lang] Fixes PUBLISH_DIR for api-quick-start
Since api-quick-start publish location (api-guide/quick-start) is
different from standard scheme, we need to explicit PUBLISH_DIR
for translated api-quick-start documents.

Change-Id: I36d54d618a7ae0f32f5b8d86488b540f1be997c6
2018-04-19 10:47:17 +09:00
Andreas Jaeger 396f4b2670 Update ZUUL variables for Zuul v3
The new jobs pass different named variables, update the translation
script for this so that the debugging info contains the right
information about the build.

Change-Id: I3ba28b4149cabffa6e8ff2b194490a0d797e1ccb
2017-11-24 18:42:55 +01:00
Stephen Finucane cb165573bc Remove the 'openstack-auto-commands' tool
The 'openstack-auto-commands' command has been superseded by the
'cliff.sphinxext' Sphinx extensions [1]. Remove both this and the helper
script in 'bin/doc-tools-update-cli-reference'.

[1] https://docs.openstack.org/cliff/latest/user/sphinxext.html

Change-Id: Ia20ace51377290997566b89ad4f78a941358cb86
2017-10-04 11:47:58 +01:00
Andreas Jaeger eccac102db Cleanup doc-tools-check-languages
Remove obsolete content.

Change-Id: Ibbb7ee0c3ebc7d6594c580d48d9846abb67cd324
2017-08-02 20:36:44 +02:00
Andreas Jaeger 980c84aea1 Remove handling of install-guide/config-reference for Pike
We do not version the install-guide anymore, remove this setup from
doc-tools-check-languages.

Also, remove handling of config-reference, it does not exist anymore.

Remove handling of draft languages, we do not version any guides and
thus don't need this.

Change-Id: Ib9a231764b84eed015521c9a8b2397965760adab
2017-08-02 13:46:07 +02:00
chenxing 5f4394cc5f Make openstack-doc-tools can be used in the individual client repos
Change-Id: Ia9ca6bff1d779370a0e1394a7211452f04a7dd1c
2017-07-30 15:18:11 +00:00
KATO Tomoyuki 89100368b5 [cli-ref] add API version for cinder explicitly
Python-cinderclient does not use the latest Block Storage API.
As work around, we need to set OS_VOLUME_API_VERSION environment
variable explicitly so that we can generate all commands.

Change-Id: I5de94f1fd5e8a4068cb7209062588eb6ade73fc8
Closes-Bug: #1673425
2017-03-22 00:08:06 +09:00
KATO Tomoyuki af4e2fb6e1 [cli-ref] support aodhclient
Change-Id: I62ec16e9660646c93392abf14d2b9f4a238e06bd
2017-02-08 21:34:29 +09:00
Andreas Jaeger bed10f856b Fix building of translated Install Guides on Mitaka
This fixes https://review.openstack.org/#/c/427596 - to skip the Debconf
guide if it does not exist.

Change-Id: Ic78068b9ce08f878049a07e1bb7891ccf4aa58ab
2017-02-01 14:39:24 +01:00
Ian Y. Choi 2356c4d4e6 PDF support using --pdf option
Change-Id: I4a609fbd5d7b04c1f9c8c1b25d68072dab097ff1
Implements: blueprint build-pdf-from-rst-guides
2016-11-30 01:54:49 +09:00
Jenkins 897bbccdd1 Merge "doc-tools-check-languages: Output NEWREV" 2016-11-21 07:25:16 +00:00
Andreas Jaeger 40ef49032b doc-tools-check-languages: Output NEWREV
Output the ZUUL_NEWREV variable as part of the root marker for better
debugging of published files.

Change-Id: I845053da6a9ce222e5f7150a9bbf3089c1cdb7cb
2016-11-18 20:02:57 +01:00
Andreas Jaeger 4d7d799cc3 Only build debconf if it exists
Not all branches have a debconf directory, so only build the guide if
the directory exists.

Change-Id: I3dda9da6f78b54a7f821562a04c1ba2d20823312
2016-11-18 18:14:46 +01:00
Andreas Jaeger 387e8288c7 Add error check for doc-tools-check-languages
Use -xe for bash invocation so that log contains all commands executed
and any failure will abort the build.

Change-Id: Ic59515bec3ae7ea9cb1d2bd97e05d95e006eafb8
2016-11-18 16:45:38 +01:00
Andreas Jaeger 5d48d9738b Fix doc-tools-check-languages
Add missing \ so that command line is parsed correctly.

Change-Id: I308dc835e5535b9f4affc67f385f6edd77aafc86
2016-11-18 15:28:26 +01:00
Andreas Jaeger 99c3a4d777 Properly pass arguments for language building
Do not give sphinx-build as single argument, split it up.
tox 2.5.0 currently complains that it cannot find "sphinx-build arg1
arg2" - so, pass this properly now.

Add releasenote for this.

Change-Id: I5da1d06866c16a8c56be23e87817d163b28803a8
2016-11-18 15:16:48 +01:00
KATO Tomoyuki dfe59880be [cli-ref] cleanup osc cli reference tools
Change-Id: Ie45534cc18a8b0a4d6b2e3f38fa45ce702cf981e
2016-09-25 14:35:21 +09:00
Andreas Jaeger 54aa873505 Add root-marker file to translated manuals
This is needed for publishing in the future:
This is so that we can create a list of directories to ignore when we
rsync documentation builds to a publishing site. Some builds are
published as subdirectories underneath the results of superior
builds.

This allows those superior builds to be rsynced without removing the
other builds that were published under them.

http://specs.openstack.org/openstack-infra/infra-specs/specs/doc-publishing.html

Change-Id: Ic8773caebecafa87b10c1ad4612bde6b1513b667
2016-09-16 09:45:09 +02:00
Andreas Jaeger a9b1818223 Fix install-guide draft translated publishing
Use a central TAGS variable for install-guide and use it everywhere. We
missed debian and debconf in one place and thus publish that translated
content in the wrong place.

Do the same change for first-app.

Change-Id: I2f9605f8632f746cb16b0a8ee241f68a311e2855
2016-08-29 12:43:22 +02:00
KATO Tomoyuki 69746f4982 [cli-ref] add rmdir to cleanup working directory
Change-Id: I40deb83f849782cb9f68d695c14643c4fa89aca6
2016-08-01 13:36:24 +00:00
KATO Tomoyuki 96e45d62c7 [cli-reference] remove oslo.log installation
The latest release of python-saharaclient has oslo.log dependency.

Change-Id: Id9dad3821f90f7fc8f64c39965999317f8b7e7c4
2016-06-09 22:50:14 +09:00
KATO Tomoyuki 2915229e0b [cli-reference] Remove Cue project
Cue project became an unofficial project.

https://review.openstack.org/#/c/324412/

Change-Id: I662956f2a39586bc8a30f5b842d787180c8aac9e
2016-06-09 17:13:25 +09:00
Jenkins 558cebe091 Merge "Factor out Install Guide for Debian with debconf" 2016-06-03 18:47:21 +00:00
KATO Tomoyuki 8b9a52f570 Factor out Install Guide for Debian with debconf
Sync install guide translation build tool with the
changes I8df6b3b382137d08d60f85bc41bcd98ac1f4eb47
and Iffced3907ac2fddd42e6adc56b6e4859fde8e987.

Change-Id: Ie3d20ab930738925f2daacd4cd305b4ad8ec1798
2016-05-28 14:26:23 +09:00
KATO Tomoyuki 1d3b8dc83a Remove common directory switcher
Since we finished common directory migration from common-rst
to common, this patch removes common directory switcher, that
is merged at the change I7ba517136807513f982e66010906b97621f844fc,
to migrate common directory for rst files from common-rst to common.

Change-Id: I40aac8ec2d497d83b41048b2576a3a0ab04c8a93
2016-05-28 13:37:48 +09:00
Andreas Jaeger 992fb6cdb4 Remove DocBook XML translation support
Remove commands and scripting for translation of DocBook XML.

implements bp docbook-removal

Change-Id: Iadb4d8609dffe9e3e449b6fe09db939ea7fca943
2016-05-02 12:57:34 +02:00
Andreas Jaeger eb89b3b919 Remove glossary handling
The DocBook XML glossary is gone, remove the special support in our
tools for it.

implements bp docbook-removal
Change-Id: Ida2bb926718ae7e03ac2ded120cea99c80147857
2016-05-02 11:16:44 +02:00
Jenkins 22201b96bf Merge "[cli-ref] Support DeprecationWarning for version number" 2016-04-22 06:15:06 +00:00
KATO Tomoyuki 8e2d482e26 [cli-ref] Remove keystone CLI support
no more keystone CLI in favor of openstackclient
http://lists.openstack.org/pipermail/openstack-dev/2016-April/092471.html

Change-Id: Ib88242d02511c7d7f94c2dbc6ddc8d855ce5541a
2016-04-20 00:29:10 +00:00
KATO Tomoyuki c6d39996ac [cli-ref] Support DeprecationWarning for version number
Bash variable expansion "${version##* }" doesn't match the char ")"
as "*". This patch add the process for "DeprecationWarning)" message.

Change-Id: If8e7dd047ea5e12487dc90f5a0fb7aeb4292ae13
Closes-Bug: #1565574
2016-04-16 10:39:48 +09:00
Joseph Robinson 4ecc2757e2 [User Guides] Remove Admin User Guide from Tools build
1.) This patch removes the Admin User Guide from the
    Tools repository.

Change-Id: I97b180dff42893a9fa3d7872f73ed2935580d099
Implements: blueprint user-guides-reorganised
2016-04-06 17:49:31 +10:00
KATO Tomoyuki 9d75f8393c [cli-ref] Add osprofiler installation for --profile option
Change-Id: I9761acb669dacd095e4a4817753f9f911184ac3a
2016-03-30 20:30:16 +09:00
Andreas Jaeger d01a68d5ea Do not publish translated Debian Guide
The RST Debian Install Guide is not maintained, there's no need to build
and publish it. We continue pushing strings to translate.openstack.org
but will not build it.

Change-Id: I2dddb437a693d91d8116cb3b5ee76e008429b0c0
2016-03-21 13:31:15 +01:00
KATO Tomoyuki c423d9e82a Remove parallel building
Parallel building is not working reliable with errors, I just had a
problem were the script run successfully but should have failed.
Let's be on the safe side...

Also fix  "WARNING: term not in glossary: fqdn" and
"WARNING: unknown document: example-architectures".

This shows that the parallel building hit problems, otherwise this
would not show up now.

Change-Id: I731de4def0a00e8f94c0d997d5bd66f5ec438e87
Co-Authored-By: Andreas Jaeger <aj@suse.com>
2016-03-18 13:42:19 +09:00
Andreas Jaeger 2530250a79 Remove parallel building
Parallel building is not working reliable with errors, I just had a
problem were the script run successfully but should have failed.
Let's be on the safe side...

Change-Id: I9ebebf33e2da0e71325b229c2261a22b07a06574
2016-03-15 15:45:17 +01:00
KATO Tomoyuki faaee70a62 Change Git message got cli reference update
Shorten commit message to follow the git convention.
Change Git topic branch to unify all related topic.

Change-Id: I3a40ca5d7bb078fec20ad9fb7a5258f8fd1ae14c
2016-02-13 22:01:42 +09:00
KATO Tomoyuki 83a7248a32 Add switcher for common directory
To migrate common directory for rst files from common-rst to common,
Add a switcher for common directory as a temporary trick.
When find a rst file in common directory,
we use "common" directory as priority.
This switcher will be removed after all migration works finish.

Change-Id: I7ba517136807513f982e66010906b97621f844fc
2016-01-25 19:04:03 +09:00
Jenkins 3bc3a7bceb Merge "Add Topic tag in cli-reference generated script" 2016-01-24 22:24:53 +00:00
Jenkins bbf792373c Merge "Remove tuskar handling" 2016-01-24 22:18:14 +00:00
Jenkins e59618644c Merge "Address pep8 warning at doc-tools-check-languages" 2016-01-24 17:51:02 +00:00
Andreas Jaeger 704370e8db Remove tuskar handling
The tuskar client has been retired, we do not need to document it anymore,
so remove all traces of it.

Change-Id: Ia12e1dcf6e147005e04da6ce07aefdbcd69750b6
2016-01-24 18:42:20 +01:00
venkatamahesh 41a1197124 Add Topic tag in cli-reference generated script
Change-Id: If9052ec4671e7bfd05dc6aa468335faf15988217
2016-01-24 20:41:38 +05:30
KATO Tomoyuki 4403ef6367 Address pep8 warning at doc-tools-check-languages
Change-Id: Ifa6ae3657af2c55622b1d292b6451386403857b9
2016-01-17 22:24:27 +09:00
KATO Tomoyuki a25b753af2 Update CLI Reference generation tool for RST
To migrate CLI Reference from DockBook to RST,
output the documentation in RST format,
with a few work around for RST/Sphinx specific issue.

Change-Id: I32b4cfefa978436061d882f7520bbc92c1645b4e
Implements: blueprint cli-ref-rst
2016-01-15 07:01:14 +00:00
Jenkins 6de1b0bf31 Merge "Update osc plugins" 2016-01-04 05:47:39 +00:00
Andreas Jaeger 62fb731deb Install optional cliff dependency
cliff-tablib is an optional dependency for cliff and needed for html
output. Install it so that command line help is available for html
output.

For details see
http://docs.openstack.org/developer/cliff/list_commands.html#other-formatters

Change-Id: Ia4fc663d876808fed89dc1fa3efaace441c563ea
2016-01-01 09:00:52 +01:00
Andreas Jaeger 3b8080fb90 Update osc plugins
Add barbican and include sahara again, it passes now.

Add oslo.log as dependency for sahara.

Change-Id: I17ecc269a752d951f43e023f72c8962cd2b7b07d
2016-01-01 09:00:25 +01:00