Commit Graph

87 Commits

Author SHA1 Message Date
Hervé Beraud 32f01991b2 Cap jsonschema 3.2.0 as the minimal version
Previous versions of jsonschema (<3.2.0) doesn't support python 3.8 [1].
Python 3.8 is part of the victoria supported runtimes [2] so we now force
to use jsonschema version 3.2.0 to avoid issues, remove ambiguity and ensure
that everything works with python 3 in general.

[1] https://github.com/Julian/jsonschema/pull/627
[2] https://governance.openstack.org/tc/reference/runtimes/victoria.html#python-runtimes-for-victoria

Change-Id: I9f540025c9d57d3c6eb27b0d3821b0ba2329de52
2020-05-26 22:02:46 +02:00
Andreas Jaeger 075cf9aeba Update openstackdocstheme version
Switch to openstackdocstheme 2.2.0 version.

Update Sphinx version as well.

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

Set openstackdocs_auto_version to not version the documents and
openstackdocs_auto_name to use project as name.

Set openstackdocs_pdf_link to link to PDF files for the two
guides that build PDFs. Note that
the link to the published document only works on docs.openstack.org
where the PDF file is placed in the top-level html directory. The
site-preview places the PDF in a pdf directory.

Update copyright.

Change-Id: Ibd4844364d78abd135e5b094beba8f17503fab26
2020-05-19 13:58:41 +02:00
Andreas Jaeger 3dfd9edbb4 Update hacking for Python3
The repo is Python 3 now, so update hacking to version 3.0 which
supports Python 3.

Change-Id: Idabf1e8f412c0c3e832ff563e66adc521986b8ae
2020-03-30 21:40:54 +02:00
Andreas Jaeger 48cd6edf98 Small cleanups
With newer openstackdocstheme versions, many settings like
html_last_updated_fmt and latex are setup correctly and don't need to
setup in this repo anymore. We require a new enough version, so remove
the obsolete settings.

This repo now requires python 3, so remove python 2.7.x support.

Update hacking to current version supporting python 3.

Change-Id: I238eefeed275fe8115d0e253ca50d38086934b1e
2020-02-22 17:28:31 +01:00
Andreas Jaeger f7c73f8c69 Update for openstack-doc-tools 2.0
With the new release, we can remove some hacks ;)

Change-Id: Ifccb5879e62531495f2c8b470dace294e991ca58
2019-08-22 13:31:49 +02:00
Andreas Jaeger e850cb234f Add api-quick-start translations
Enable the newly imported translations.

This needs openstack-doc-tools 1.10 for publishing to
the correct location of translated api-quick-start.

Update index pages to link to new location.
Disable link to Japanese API guide since it's not published currently
(too few translated strings).

Change-Id: Ie79ce7be7d6c16c9954f50c77f6618c9c2974c3e
2019-07-24 14:21:05 +02:00
Adam Spiers 4a53589fea www-generator.py: cache expensive repo/project metadata to disk
Gathering the metadata of repos and projects requires a significant
number of HTTP calls and is therefore slow and expensive.  When
hacking on www-generator.py the ability to skip these calls can save a
lot of time allowing much more rapid iteration.  So add a persistent
cache for this data, using the percache Python module.

This is mostly run in the gate, where the cache will be deleted on
each run.  Documentation contributors running this locally may
occasionally need to manually remove the cache file, although
governance data generally changes slow enough that this is expected to
be a rare corner case.

As noted by the comment in _get_official_repos(), in the future we may
add support for loading governance data from a local repo, thereby
skipping the need for slow HTTP calls.  But for now this is a simpler
solution.

Change-Id: Ib52171625e37169d00da03f436b58456c103b04d
2019-01-04 17:10:22 +00:00
ZhijunWei a73e7353df Update hacking version
Change-Id: I72b20dd73d049b933cf37b75708a46ffae336b34
2018-12-26 15:44:58 +08:00
Doug Hellmann 220142cb0b use openstack-governance library
Rather than downloading and parsing the governance data ourselves, use
the library published out of the governance repository to do it.

Depends-On: https://review.openstack.org/621277
Change-Id: I65b0b7e799eaa1ecb2059ed16a5e3e53f7a92853
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
2018-11-30 14:50:52 -05:00
Andreas Jaeger 063cf760c3 Remove display_badge setting
We do not need to disable badge with openstackdocstheme 1.23.1 for
releasenotes anymore, remove it.

Change-Id: Id2c12564b6933a106d7795631c531a6e2a54e2b9
2018-08-24 12:10:36 +02:00
Andreas Jaeger cb4369bee9 Disable badge
All documents are versionless, disable badge for pointing out releases.

Change-Id: Ie0496a947529416d627baae1a27b84b20d070d13
2018-08-21 14:34:15 +02:00
Andreas Jaeger 0fee1f635e Update to openstackdocstheme 1.18.1
This fixes our bug links, let's use it everywhere.

Change-Id: Ica7618bf41000fb574427c482d08fb0a0f23628a
2018-01-24 07:07:51 +01:00
Andreas Jaeger 0253ad57cc Update hacking
Update to current hacking version.

Change-Id: Ia4b7918e74b8e2de851ca823fc75ee6335ef73e3
2017-10-31 15:43:19 +01:00
Doug Hellmann 1ea00d70cb raise whereto minimum to 0.3.0
This will give us the version that supports testing that a path does not
redirect.

Change-Id: Id3138c78b0344a1babec6e3f7d7992b2867cb2a2
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
2017-10-27 08:59:31 -04:00
Doug Hellmann dcd0ce9584 use whereto to test redirect rules
Add a file containing the tests for all of the redirect rules and set
up whereto to run during the check. The test file is a template, just
like the htaccess file, to ensure we auto-generate the rules for all
of the various project redirects.

Fix a few issues with the template generator that ended up producing
duplicate or useless rules.

Change-Id: I0d306149dc33f64d44d9482fab02101bd1f6d7f5
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
2017-08-25 18:56:14 -04:00
Monty Taylor 27ebdb01df Use os-service-types for service type validation
We wrote a library to encompass this data, and it knows a bit more about
how to handle things like placement and whatnot. Use it.

Canonical name for senlin is clustering, use that one to fix build.

Change-Id: I215fb11c1e7e6aac5e020f3f3da3a0a0632cc2eb
2017-08-18 19:57:33 +02:00
Andreas Jaeger aa284a69c2 Remove reno, add pike releasenotes
Remove reno, we only used it for a single entry so far and since the
manual is now not branching anymore, let's not do use it.

Create a new pike releasenotes page.

Remove unreleased page, we don't need it.

Change-Id: Ieecdf0d16b26267d7ce6bfcba37d25551b226f32
2017-08-02 21:52:38 +02:00
Andreas Jaeger 34c6567141 Update requirements for Pike
Require newer doc-tools and theme for pike.

Change-Id: Ib459d0393f88866f0e43414ab11d16be8a34873f
2017-08-02 15:49:35 +02:00
Andreas Jaeger 9dceacc5f1 [install-guide] The guide is version independent
Remove watermark for pike. This allows to remove sphinxmark extension
usage, so remove it and pillow from test-requirements and update
contributor-guide for this.

Explain that guide handles Pike release now.

Change-Id: Ib1c71971b822cc0aa3e6531b2d5607714551d9db
2017-07-21 21:42:42 +02:00
Doug Hellmann 6afbdc55c6 remove the cap on pillow
Remove the cap on Pillow and require the latest sphinxmark to ensure
that we have compatible versions of the libraries.

Change-Id: Ib053e48f72020bef64987bc22ded4d83ea322be4
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
2017-07-05 10:52:07 -04:00
Doug Hellmann 8715ead60f add jsonschema validation to the start of the template rendering
Change-Id: I289b4497ceffec896bbcda42d89c15fb88aba1c4
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
2017-07-03 08:46:57 -04:00
Doug Hellmann 2e587af407 add a global project list file for main site templates
Change-Id: I4a14ccbdd743a132d6186c4312b865cda64b5db1
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
2017-07-03 08:46:57 -04:00
Doug Hellmann f52ec61a68 cap Pillow < 4.2.0
There is an API change in Pillow 4.2.0 that breaks our watermarking
step.

Change-Id: I8a8c9d87a7165521c8d86167657b25dc51d5b610
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
2017-07-03 07:52:29 -04:00
Andreas Jaeger b1bad0d43a Simplify conf.py for openstackdocstheme 1.11.0
With the new openstackdocstheme used, we can simplify conf.py.

Also, update our docs for it.

Note that Sphinx 1.6 needs latexmk for building, add it.

Sphinx 1.6 introduces a few new warnings, fix them so that the guides
built.

Change-Id: If2e431725eb54f8be79b9fa4bf9ede2089f321a5
2017-06-27 07:04:30 +02:00
Andreas Jaeger b2ff0cf9a3 Update requirements
Sync with global requirements to update to newer versions.

Main updates are for our theme and tools.

Change-Id: I71b70229b93ccfdba393718f2fbf9163427aed7d
Depends-On: Ifc5512c0e2373cf3387e0e0498268eab092e52bb
2017-06-26 21:06:05 +02:00
Colleen Murphy 50e5191704 Fix encoding issues
While this may look like a noop change, it removes an invalid character
that was causing the checkniceness tests to fail. We can also now unpin
the chardet library.

Change-Id: Iaa4e7069187d048ad375376c25b1de4b142b62ad
2017-04-12 17:37:28 +02:00
Andreas Jaeger 8af952bfa7 Blacklist chardet 3.0.x
Our builds are failing due to chadet 3.0.0 and 3.0.1, blacklist the versions.

Change-Id: I5801f4d94a5e1e1998c3de2731a4bd824de6e1ce
2017-04-12 15:47:42 +02:00
Andreas Jaeger 663213c2be Blacklist Babel 2.4.0
Babel 2.4.0 does not handle "-" in locale po files like "ko-KR". This is
fixed now for the upcoming Babel 2.4.1 release.

To be able to publish translated content, blacklist Babel 2.4.0.

Change-Id: Iba67e38da6f8c6773d91c4fd63d9467fb9dc5c90
2017-04-06 14:27:35 +02:00
Andreas Jaeger 44c4b02b44 Update openstackdocstheme requirement
For PDF style, we need openstackdocstheme 1.7.0 or newer - update
requirement.

Change-Id: I5022e4963135491c929a2123c74291fe37f626dd
2017-03-23 14:13:16 +01:00
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 df116c9e35.

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 9432a6da0c.

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