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
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
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
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
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>
We do not need to disable badge with openstackdocstheme 1.23.1 for
releasenotes anymore, remove it.
Change-Id: Id2c12564b6933a106d7795631c531a6e2a54e2b9
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>
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>
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
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
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
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>
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>
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
Sync with global requirements to update to newer versions.
Main updates are for our theme and tools.
Change-Id: I71b70229b93ccfdba393718f2fbf9163427aed7d
Depends-On: Ifc5512c0e2373cf3387e0e0498268eab092e52bb
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
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
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
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
Update requirements to current Sphinx version. Don't auto-upgrade to
next major version.
Fix one lexing issue.
Change-Id: I6e4164661a8b21cc6251176afe8020df8a914011
Sync licenses with global-requirements.
Add Babel for translations.
Update versions for our tools.
Increase hacking version as in global-requirements.
Change-Id: Ie09303f1d3f5246c8b3628e2f4a362251da63505
Adds a Newton watermark to the Install Guides,
Networking Guide, and Config Ref Guide.
Change-Id: I0e4f2942b87d996e9f2fd419f808578636d07e78
Backport: mitaka liberty
Partial-bug: #1479166
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
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
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
The Japanese translations have been imported, build the guide.
This needs openstack-doc-tools 0.30 or newer, bump the requirement.
Change-Id: I5b55aed7db9e83ce9a0f5057ab9567ee62a391ca