23 Commits

Author SHA1 Message Date
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
Andreas Jaeger
699e82d2d2 Enable release notes translation
Releasenote translation publishing is being prepared. 'locale_dirs'
needs to be defined in conf.py to generate translated version of the
release notes.

Note that this repository might not get translated release notes - or
no translations at all - but we add the entry here nevertheless to
prepare for it.

Change-Id: Iace1593dff20324b86c7245c2217d51d77d9a465
2016-10-06 20:40:37 +02:00
Jenkins
6b669e8778 Merge "[cli-ref] cleanup osc cli reference tools" 2016-10-01 11:20:05 +00:00
KATO Tomoyuki
ff558eb3b1 Move release notes to be handled by reno
Change-Id: I09b42465c834065073e29eecc9603b893ddab978
2016-09-29 20:48:54 +09: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
fe586291ff Remove openstack-doc-test
openstack-doc-test is used for building of DocBook XML files. For index
page generation openstack-indexpage can be used.

Remove openstack-doc-test together with all support files.

Change-Id: I5589bc634e1f630f79b3d6e8bffee939c5300bf2
2016-05-19 01:51:03 +00: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
KATO Tomoyuki
6f4a9758b5 Set the bug project to i18n for the translated docs
Change-Id: Ia86334649990a09c02a379c10adae55594a68c1d
Closes-Bug: #1277544
2015-12-13 17:22:07 +09:00
Gauvain Pocentek
5c743c3d4a [autohelp] allow overrides of sections
We want to be able to change the section in which an option is
registered in the documentation. This patch uses a <project>.overrides
file to define in which section(s) an option should be moved.

The format of this file is (1 line per option):
[<group>/]<option> <new_group1>[ <new_group2> ... ]

Change-Id: I9fd0b763b6e56cd360694566de7f3acc3172c9c1
Closes-Bug: #1522794
2015-12-05 15:09:53 +01:00
Andreas Jaeger
39b5ecfbd9 Improve index page layout
Split up draft guides under separate heading and remove draft word for
easier review.

The output looks now basically like:

Generated documents
admin-guide-cloud
contributor-guide
networking-guide
user-guide
user-guide-admin

Draft Guides
arch-design-rst
config-ref-rst
image-guide-rst
install-guide-debian
install-guide-obs
install-guide-rdo
install-guide-ubuntu

Also, create separate tool openstack-indexpage that only generates index
page.

Change-Id: Ic68a674918f18dc37f8b9fa4e9d9f529a8ad131e
2015-11-21 19:57:10 +01:00
Andreas Jaeger
8391493619 Reno: Remove unreleased and merge with index
We don't need an extra index file, merge these two.

Change-Id: Iedc64b022b8faa9014865a0b459e50ebe208cdea
2015-11-17 17:44:29 +01:00
Jenkins
02c8acc02a Merge "Rework install guide translation build tool" 2015-11-16 13:38:29 +00:00
Jenkins
08e154dc4d Merge "swift flags: read from RST" 2015-11-16 05:24:35 +00:00
Gauvain Pocentek
32158abe15 swift flags: read from RST
The extract_swift_flags.py script parses the existing docbook tables to
discover documented options. We're now switching to RST so implement
reading from RST tables, and make it the default behaviour.

Implements: blueprint config-ref-rst
Change-Id: Ib7a14cc52337fc1abd8b02a8ff33396c0b992746
2015-11-15 15:24:49 +01:00
KATO Tomoyuki
9abcfea69c Rework install guide translation build tool
Sync translation build tool
with Change-Id: I3abcd7da3569bb8e9edbc02574dcb74c12752ede.

Change-Id: I45f66ba19d0946175dbace95082454bdd1187bf1
Closes-Bug: #1516079
2015-11-15 14:04:13 +01:00
Jenkins
a46b5a91f0 Merge "Update RELEASE Notes" 2015-11-15 10:55:26 +00:00
Andreas Jaeger
3f96fbeca3 Update RELEASE Notes
Mark RELEASE_NOTES.rst as obsolete and give pointer for new work flow.
Move one entry from current RELEASE_NOTES to reno.

Change-Id: I94d81e00d0a4405c1dfce9fdb83a2ec6f26eae5a
2015-11-15 09:56:56 +01:00
Andreas Jaeger
f1f94028d0 Add Reno entry for RST autohelp
Change-Id: I3e3c42482d85f3e0ee94d662a3d75cf5c78cc10f
2015-11-15 09:48:33 +01:00
Jenkins
648336763a Merge "Automatically generate content for master" 2015-11-11 00:17:48 +00:00
Andreas Jaeger
0e3637bb20 Automatically generate content for master
As suggested by Doug Hellmann, properly define the release-notes to
automatically generate content.

Change-Id: I4c2f9086d40ef428239943240f61c74cf16e1ab6
2015-11-10 08:36:01 +01:00
Andreas Jaeger
9ac5de89fc Remove now obsolete placeholder
The directory has content, we can remove the placeholder now.

Change-Id: I0bcfde2ca531b93f7a4cdea12abc673c05894b1f
2015-11-09 20:38:01 +01:00
Andreas Jaeger
4c77a32ada Add reno for release-notes
Add renote to automatically generate release notes - the same way other
OpenStack projects do it.
For details see
http://lists.openstack.org/pipermail/openstack-dev/2015-November/078301.html

Change-Id: I9789c5e21d8594593fc5536562a01644c6d63eef
2015-11-07 17:10:06 +01:00