58 Commits

Author SHA1 Message Date
Stephen Finucane
c80053275e Bump pbr to 2.0
pbr 1.10 is broken with Sphinx 1.5 [1]. We've somehow avoided any
issues, likely because we don't restrict ourselves to 1.10, but we
should make the version number explicit.

[1] https://bugs.launchpad.net/pbr/+bug/1379998

Change-Id: If3dbb6f2131530bcaddc96ca419ce56d2fb2d50a
Related-Bug: #1379998
2017-03-16 17:12:11 +00:00
caoyuan
072cb53792 Update hacking test requirement
Update hacking to version from global requirements to keep us in sync
there.

Change-Id: I3093a76ca9a3054c0373b384bbf9deb2f7693f49
2017-03-06 12:19:16 +00:00
Adam Spiers
58dbdffcf2 prepare to use reno from Pike onwards
A stated goal from the Atlanta PTG this week was to use reno for our
release notes from Pike onwards.  This requires reno to support
configurable sections, which have been added by:

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

Once this is merged into reno, this commit configures openstack-manuals
so that reno will work with it, and a build of releasenotes/ will
automatically include a reno-generated report via reno's sphinx
extension.

Depends-on: I914572c6a07ca81c54965b4b5a6b6aba50b3a787
Change-Id: Id029f462fb553b3429629b90585e2790734f1bb9
2017-02-23 18:22:25 -05:00
Brian Moss
05e76bf9bf Add license comment for sphinxmark
Change-Id: I1fc85dcc034f3233cf2bbb6f2fb0385521a8057e
2017-02-23 10:46:14 +10:00
Andreas Jaeger
6b6b815fe6 Switch to current Sphinx
Update requirements to current Sphinx version. Don't auto-upgrade to
next major version.

Fix one lexing issue.

Change-Id: I6e4164661a8b21cc6251176afe8020df8a914011
2017-01-13 16:36:45 +01:00
Andreas Jaeger
e1b0ead791 Add requests to fix building
Building fails, add requests as dependency.

Change-Id: I537a1ee8cc899373d9375fc5ed4f48e914dbd40e
2017-01-09 19:32:01 +01:00
Andreas Jaeger
e15dbef97e Blacklist broken lxml release
Blacklist lxml 3.7.0, it's broken.

See also I0dcecac58f8916fc114a743e6c9dcba79e0b20bf

Change-Id: I3614fe5e4a98b4d657d4487617d8e85b0e1cb3d7
2016-12-23 10:00:52 +01:00
Andreas Jaeger
de90f04dd2 Sync requirements with global requirements
Allow newer sphinx version, see
Icea69cbcb9deb1d09c0808bbd5f1001ffecf2129.

Change-Id: If2a75d37b25e10dabdfffdf1b7fa29af257507fc
2016-09-28 18:54:44 +02:00
Andreas Jaeger
b3e009712f Update requirements
Sync licenses with global-requirements.
Add Babel for translations.
Update versions for our tools.

Increase hacking version as in global-requirements.

Change-Id: Ie09303f1d3f5246c8b3628e2f4a362251da63505
2016-09-22 09:14:45 +02:00
Brian Moss
aa4ff78daf Add watermark to Newton versioned guides
Adds a Newton watermark to the Install Guides,
Networking Guide, and Config Ref Guide.

Change-Id: I0e4f2942b87d996e9f2fd419f808578636d07e78
Backport: mitaka liberty
Partial-bug: #1479166
2016-09-06 15:54:30 +10:00
Andreas Jaeger
4339c071bb Update for openstack-doc-tools 1.0.0
Require the new release and remove openstack-doc-test from
checkniceness, this was only needed for docbook XML files.
The command does not exist anymore.

Change-Id: I88c39f3c85935300c0377c028997f5009969b373
2016-08-22 18:10:19 +02:00
Andreas Jaeger
828870df7f Require openstackdocstheme 1.4.0
Update requirements to require current version.

Change-Id: I7bdd0a56202ad1d8363e3ae39927c85f55ba9351
2016-07-20 13:16:21 +02:00
Andreas Jaeger
3ce64f6e60 Disable Insecure warnings
Disable urllib's warnings, there's no way to fix these in our builds
right now.

Change-Id: I6621d28a643b4c786b6a5615fac95c998daf3432
2016-03-04 13:14:52 +01:00
Andreas Jaeger
1f2d4b1ad9 Revert "Temporary require debtcollector"
The problem has been fixed with newer oslo.config 3.6.0 release.

This reverts commit df116c9e35fbc58b080e48d4a97b71d6892b665b.

Change-Id: Iacc52fe47850fd40cd258bf0caee2f1eae191334
2016-02-10 08:44:24 +00:00
Andreas Jaeger
df116c9e35 Temporary require debtcollector
Unwedge the gate as long as oslo.config needs debtcollector but does not
require it.

Change-Id: Ifbf00fd4a69bf223c9916230698b7109ce8d707e
2016-02-09 07:26:06 +00:00
Andreas Jaeger
2f12717263 Require openstack-doc-tools 0.33
Require current version, this enables us to rename common-rst directory.

Change-Id: I0d3f358f4cc4939bfeffdd818ec6e44f0e9362c0
2016-02-01 19:58:24 +01:00
Andreas Jaeger
65a556d352 Manual sync with global-requirements
Since we're not part of global-requirements sync, do a manual sync.
This updates Jinja to newer version as well as normalizes the entries.

Change-Id: If41108d7831c7913b8203b5ffdbc9a9bdd3a148e
2015-12-14 07:53:01 +01:00
Andreas Jaeger
cbeb4d5c5b Revert "Add reno for release-notes"
As discussed via email, let's do this on a smaller scale.

This reverts commit 9432a6da0cc341a879bc6f4ac48380248355e77a.

Change-Id: I27e9cd06c5d69917abe452e873873683e10c282a
2015-11-10 14:49:13 +00:00
Andreas Jaeger
9432a6da0c 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: Iac8f34ae3490b7788c989b17be3e6a616e65c676
2015-11-07 17:34:29 +01:00
Andreas Jaeger
c9b1992205 Update for openstackdocstheme 1.2.3
Require new version and cleanup conf.py, we do no need pwd variable
anymore.

Update pbr and hacking requirement - syncing with global requirements.

Change-Id: I53a222445967092e08a1b598a19e8bbe71e378a6
2015-10-06 19:43:30 +02:00
Andreas Jaeger
c0b3aeebd3 Publish Japanese Install Guide as draft
The Japanese translations have been imported, build the guide.

This needs openstack-doc-tools 0.30 or newer, bump the requirement.

Change-Id: I5b55aed7db9e83ce9a0f5057ab9567ee62a391ca
2015-08-25 06:45:32 +02:00
Andreas Jaeger
f69c489346 User Guides: Enable translations
openstack-doc-tools 0.28 contains a fix for translation of RST guides
and the User Guides. Require that version and enable the User Guides for
translation.

Add building of glossary for translation environments to tox.ini.

Change-Id: I645bf98b68603811a9a978e508d1f492e44da738
2015-05-13 22:13:41 +02:00
Andreas Jaeger
1713dabf56 Unify checkbuild and publishdocs
The two tox environments were large and mostly duplicated, use a shell
script instead and use the build-rst.sh script to simplify building and
publishing.

For copying to /kilo, use the tools/copy-to-branch.sh script instead of
the simple commands since that is more robust. Merge that script into
this script, no need for a second script.

Update requirements: We need 0.27 at least to not have to delete the
Debian Install Guide, sync also pbr with global-requirements.txt.

Change-Id: Ieba77b4e3d0bbe58db041206d9725c523b3bb43a
2015-05-13 20:01:56 +02:00
Andreas Jaeger
b84857108c Build translated RST manuals
Build translated RST manuals. This needs openstack-doc-tools 0.26
release, thus bumped up requirements.

Import also Japanese User Guides translations so that this can be
tested. We only create an empty file for it, this will trigger the
import and enable us testing of the toolchain.

Ignore some build results.

Change-Id: Ic51974445730cbfa886beb7cfd4fcf71977dab3c
2015-05-07 08:06:14 +02:00
Andreas Jaeger
75c5b45173 Update for openstack-doc-tools 0.25
Require openstack-doc-tools 0.25. This allows us to remove the content
directory for RST checkbuild.

Change-Id: Iffbdbb312c4e74902aec3cd4ebbfb5e4a4d83a76
2015-04-30 07:34:02 +02:00
Andreas Jaeger
9c1b3b2b66 Update openstackdocstheme to 1.0.7
Change-Id: I1154accd37eba7dff02fddc4311bb13fb94599fe
2015-04-24 17:18:21 +02:00
Andreas Jaeger
31b7f646fa Remove oslosphinx requirement
We do not need this oslosphinx anymore and thus can remove it from
requirements.

Change-Id: I3125b8fdc0ce0bff3601f345d3fbc6decec2d5cf
2015-04-24 08:28:19 +02:00
OpenStack Proposal Bot
04423f448e Updated from global requirements
Change-Id: Iac1fa4401dece94f0e9a767bf3370d830e5955fc
2015-04-23 21:53:01 +00:00
Andreas Jaeger
21ea9aff19 Reenable some doc8 tests
Enable doc8 but disable D000 (RST validation) and
D001 test (overlong lines). This also disables
all the problems we had in the past with doc8 checking, the current
files pass doc8 after fixing a few minor problems (part of change).

This basically tests for whitespace.

Change-Id: I648ac7f78b3a31f3b1434dc7d7d0b887ce4d5128
2015-04-21 16:32:06 +02:00
OpenStack Proposal Bot
de06327cce Updated from global requirements
Change-Id: I7911f68d1496a73ce57dc3e1d09da4911b4ba366
2015-03-21 00:16:27 +00:00
Anne Gentle
e6170e08a4 Remove doc8 from niceness check
- We're not at a point where the value proposition in consistent markup is
worth the pain in troubleshooting.
- Plus I think the current checks aren't sophisticated enough to replace humans.

Change-Id: Idb4e4acaf6b274024853847aa1d77324e251349f
2015-03-06 22:02:00 +01:00
Jenkins
507c9a788d Merge "Updated from global requirements" 2015-03-06 20:06:54 +00:00
OpenStack Proposal Bot
24049e83cc Updated from global requirements
Change-Id: I8e6fbb3f7a9f24902c5a9efa4215762405078df7
2015-03-06 17:03:51 +00:00
Andreas Jaeger
d82793e156 Move networking-guide source to a source directory
Patch was originally trying to use python setup.py build_sphinx to build the RST guides.
Thinking it'd give us better debugging info. But now translation needs a /source subdir.

Change-Id: I5e4f85846301bb14fcd9fb1445b08a0d34d16cae
2015-03-05 20:33:42 +01:00
Christian Berendt
7524c8b34f Add pep8 environment to the tox.ini file
Because we have several Python files inside this repository we should
be able to check them.

Change-Id: Iaf4a013cf0c109d60b5421c5077505fdcbb4a30c
2015-02-16 10:22:39 +01:00
Anne Gentle
55d1d6e1ef Adds build information for using new openstackdocs theme
oslosphinx must remain because the Hot template guide uses it.

Depends-On: I19ac7e4caab879217cb3024157e3ddd231f5189d

Change-Id: Ib5e68c17aba85823bca74387ee144fd961da15ff
2015-02-11 14:06:57 -06:00
OpenStack Proposal Bot
6b9ca1d250 Updated from global requirements
Change-Id: I831abee828513785092a85f9125532e27f80dcba
2015-01-27 02:33:21 +00:00
OpenStack Proposal Bot
01ec23fcfd Updated from global requirements
Change-Id: I6288a012de2ccb416f41177cf567f2c1341e8e2b
2014-10-22 00:50:38 +00:00
Christian Berendt
f9bdae0fd7 Use BeautifulSoup to prettify output of WWW pages before writing
Change-Id: I0a554091f225dff6b312d253a1ff2c1aa2cc8ac9
2014-10-14 11:11:41 +02:00
OpenStack Proposal Bot
e6d720d99a Updated from global requirements
Change-Id: Ifc1e43d89831337613595aa8a083d3bd8aeab5f9
2014-10-13 23:10:23 +00:00
OpenStack Proposal Bot
f7950242ac Updated from global requirements
Change-Id: I7c67a203a375fc18d8c8d5c3bc3a416fab8d0da8
2014-10-11 15:55:40 +00:00
OpenStack Proposal Bot
f8577e33ba Updated from global requirements
Change-Id: I24e1baf57bdd60e27d426b8537f567b0b9e38247
2014-09-19 08:50:32 +00:00
OpenStack Proposal Bot
decbca1ac8 Updated from global requirements
Change-Id: I03130190b39de9c6ee7e44ea098e16633807441b
2014-09-11 00:30:08 +00:00
OpenStack Proposal Bot
185a3808cc Updated from global requirements
Change-Id: I775ae2075cd7483a29364e235bfa086e2555c0d6
2014-08-22 12:33:25 +00:00
OpenStack Proposal Bot
018b934a1d Updated from global requirements
Change-Id: Ie3847527b8f49c2f603751997e61f8eb5971398e
2014-08-20 11:46:29 +00:00
Christian Berendt
cc9bb9db0f Add doc8 to tox environment checkniceness
Check .txt and .rst documents for common style issues.

Change-Id: I3f264ca05538834a5b26ddf76470169f3b9f6dbb
2014-08-17 09:04:34 +02:00
Andreas Jaeger
2d04ed1a60 Update for doc-tools 0.18.1
Use new doc-tools-check-languages script and add configuration file for
it. Remove the now obsolete tools/test-languages.sh.

Adjust checkbuild target so that generated index pages can be reviewed
easily.

Change-Id: I28462fb19e5f999c298e7d8cc2cc7dda41f35929
2014-08-16 19:23:24 +02:00
Christian Berendt
40b657f993 Use a static site generator to generate content in www
Change-Id: I2f0c61006ef8885e157eb2b800080407f2bae393
2014-08-14 10:02:26 +02:00
Gauvain Pocentek
cb4075048f Includes a basic HOT template guide
The 2 RST files are copied from the heat developer documentation without
any change and are just a starting point.

This patch requires this change in the openstack-doc-tools:
https://review.openstack.org/#/c/108034/

Change-Id: I03511655c86ead880cadfa68b43bb2b90d3f7c06
Implements: blueprint heat-templates
2014-07-28 21:48:55 +02:00
Gauvain Pocentek
027bb846bf Bump doc-tools requirements to 0.17
Change-Id: Iadc1d01f604cbc18c2426ab840eea21ba941231a
2014-07-27 20:34:04 +02:00