Commit Graph

42 Commits (master)

Author SHA1 Message Date
Andreas Jaeger 7ee77130c4 Switch to newer openstackdocstheme and reno versions
Switch to openstackdocstheme 2.2.1 and reno 3.1.0 versions. Using
these versions will allow especially:
* Linking from HTML to PDF document
* Allow parallel building of documents
* Fix some rendering problems

Update Sphinx version as well.

Disable openstackdocs_auto_name to use 'project' variable as name.

Change pygments_style to 'native' since old theme version always used
'native' and the theme now respects the setting and using 'sphinx' can
lead to some strange rendering.

openstackdocstheme renames some variables, so follow the renames
before the next release removes them. A couple of variables are also
not needed anymore, remove them.

See also

Change-Id: I5f985549671e3b4f8c438f247fae0818d25b21f5
2020-05-29 12:45:49 +02:00
pengyuesheng dc37b3569b Drop python 2.7 support and testing
Ussuri Communtiy-wide goal:

Co-Authored-By: Andreas Jaeger <>
Change-Id: I32d5dc317b821dee4a625506f227a8f5bfaaecfc
2020-01-27 17:03:20 +01:00
Andreas Jaeger 5793218d2b Remove openstack-jsoncheck and openstack-indexpage
These are not used anymore, remove them.

Change-Id: Ib4f8c25bc0bbd8227d21e055f07411926577714b
2019-08-19 13:04:13 +00:00
Zuul 64c33f3bb4 Merge "Remove some commented obsolete lines" 2019-08-16 11:00:53 +00: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 918cec0047 Remove some commented obsolete lines
Addressing feedback from . These comments are wrong
with current openstackdocstheme, so remove them completely.

Change-Id: Ibfb3a2e37ea5b89ce81caed3e4884ee077e0d967
2019-08-13 18:13:26 +02:00
Andreas Jaeger 06d7ac27b7 Update docs building
Use sphinx-build and cleanup unused config.
Switch to openstackdocstheme 1.20.0 and remove obsolete settings from files.

Update some RST files, they had wrong indentation.

Change-Id: Iaad2841db809f8a343fb8b1031cf8d0587d70442
2019-08-11 09:48:06 +02:00
zhouxinyong e1cd64caef Advancing the protocal of the website to HTTPS in README.rst.
Change-Id: I42c644e1e76c161ef0bd7473bf3996cb485f03e4
2018-11-14 01:11:46 +08:00
Andreas Jaeger 127df77a4b Remove setting of version/release from releasenotes
Release notes are version independent, so remove version/release
values. We've found that projects now require the service package
to be installed in order to build release notes, and this is entirely
due to the current convention of pulling in the version information.

Release notes should not need installation in order to build, so this
unnecessary version setting needs to be removed.

This is needed for new release notes publishing, see
I56909152975f731a9d2c21b2825b972195e48ee8 and the discussion starting

Change-Id: I594c14139dd8a3b313e95898ff86508fc7a40878
2017-11-16 21:24:31 +01:00
Stephen Finucane ca9ff17d27 Remove "cleanup" tools
There were a couple of scripts here:

- retf

Most of them are self-explanatory with the exception of 'retf', which I
don't understand but which looks untouched in years and therefore
useless. For the other three, we have tooling in place to ensure these
"issues" don't get into source control and, even if they did, there's
questionable value in rewriting stuff just to remove excess whitespace.
Kill them all.

Change-Id: Ifbd2d50a669251484056552da21d23906f8d6178
2017-10-04 11:48:00 +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'.


Change-Id: Ia20ace51377290997566b89ad4f78a941358cb86
2017-10-04 11:47:58 +01:00
Stephen Finucane d3c952064a Remove 'autogenerate_config_docs'
This tool has been superseded by the 'oslo_config.sphinxext' Sphinx
extension and can finally be put to rest.


Change-Id: Idae5ba656c3a0da8a26c6f1e63332365c8012c0b
2017-10-04 11:47:56 +01:00
Andreas Jaeger b914be59ca Fix URLs
Change docs.o.o/developer/ to new location.

Change-Id: I99bed6eccdf462bac6d8ac3f7b034a457a8bbdbc
2017-09-07 19:55:58 +02:00
Andreas Jaeger c3bf1aa507 Switch to openstackdocstheme
Update to use current openstackdocstheme everywhere instead of
oslosphinx, remove now obsolete settings.

Change-Id: I812f72ebf9fb4d96b1031880c44596833da9d384
2017-06-27 22:59:01 +02:00
Andreas Jaeger 5a6b8676b0 Add release-note about docs
We will publish the next release at, add this to
release note entry.

Change-Id: Ibfaf009449eb587768427f1a1d7196ed69dee8d8
2017-05-01 17:25:12 +02:00
Stephen Finucane e90895e010 Remove swift tooling
Per the comment on change 'If0cf66aa9', we no longer track swift config
files as part of openstack-manuals. As such, we can remove the special
casing for this project.

Change-Id: I135caa57e1dcdd4114033276d89fc87c28a71aac
2017-04-11 15:54:45 +01:00
Stephen Finucane 6d6f122209 extract_swift_flags: Remove '--from' argument
There's no reason to keep this around now that all Swift docs have been
converted to rST.

Change-Id: Ie9eb561394625509895420eb665523110b264a8e
2017-03-07 17:43:52 +00:00
Stephen Finucane 80d376e08e extract_swift_flags: Remove 'docbook' command
We don't support Docbook anymore and this didn't work due to missing
templates. Kill the subcommand.

Change-Id: I38514946a48804c0eb50614ea31553e2b01135ac
2017-03-07 17:43:01 +00:00
Andreas Jaeger bed10f856b Fix building of translated Install Guides on Mitaka
This fixes - to skip the Debconf
guide if it does not exist.

Change-Id: Ic78068b9ce08f878049a07e1bb7891ccf4aa58ab
2017-02-01 14:39:24 +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
Andreas Jaeger 699e82d2d2 Enable release notes translation
Releasenote translation publishing is being prepared. 'locale_dirs'
needs to be defined in 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

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

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

Draft Guides

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

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 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

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