Commit Graph

25 Commits

Author SHA1 Message Date
Sean McGinnis c356ac4c6f
Update doc build dependencies
Outdated tox settings were causing doc builds to fail. This updates the
minimum version of tox and some of the requirements to more recent
version to get past some incompatibilities.

Change-Id: I8dcd06ac01c59fcacc17846e8e5f0cc08696ed16
Signed-off-by: Sean McGinnis <sean.mcginnis@gmail.com>
2023-06-29 14:24:39 +00:00
Frank Kloeker ef75f4e066 skip translation warnings on tox build
Change-Id: I30c39d1eea901b41efece96c95cfb4f9bdc0b49c
2019-01-25 13:57:21 +01:00
Andreas Jaeger 594827f115 Add translated docs building
openstackdocstheme 1.28.0 contains a script to allow building
of English and translated documents, use this to publish our documents.

Add setup.cfg, this is needed by the openstackdocstheme.

Change-Id: I4b2af19a62af260a02eb7b48e750da69418ad1c9
2018-12-06 22:04:40 +01:00
Andreas Jaeger d12fd3653f Remove tools/glossary-sort.sh
The glossary is imported automatically from openstack-manuals, no need
to test that it is sorted as this is done in openstack-manuals already.

Change-Id: If57bda8c5f83d7c833387f0c6ee7ea570d785dac
2018-11-24 18:57:03 +01:00
Andreas Jaeger c25d0dcb98 Switch to PTI docs jobs
Switch to new PTI docs jobs, use python3 for building of docs.
Update docs job to handle warnings as errors.

Depends-On: https://review.openstack.org/594159
Change-Id: I91d1cc7066b7f98bf98cdb8b3fd146bc54cd13e1
2018-08-21 15:00:35 +02:00
Sean McGinnis c68bdb82bf Restore operations-guide content
This restores the content of the repo to include all changes that
were done while the content was moved to the openstack-manuals
repo. There were also some updates and fixes to get the content
to build and pass jobs with the current doc job definitions.

Change-Id: Ic05b44a210a93667490096cffc8f2e45575ffb34
2018-06-28 10:52:46 -05:00
Andreas Jaeger c8ca0febaa Retire repository
Retire repository following the process on retiring an OpenStack
repository:
http://docs.openstack.org/infra/manual/drivers.html#remove-project-content

This removes *all* content and just leaves a single README.rst that
explains how to get it.

Change-Id: I36ca5788dbc3e44b5421b88e64972585f8820947
Depends-On: I9f4e21b44c717d11511fea48db54a52103e294b1
2016-05-05 20:40:53 +02:00
KATO Tomoyuki 46f16d9228 Do not publish RST Operations Guide
Because of migration into openstack-manuals repo.

Change-Id: I9b4779ecabe16e4ec1b1cf5b0f565ea278075b46
Implements: blueprint ops-guide-rst
2016-05-02 12:56:40 +09:00
KATO Tomoyuki 7b824ddc5c [ops-guide] Set up initial RST structure
Change-Id: Ife2178f4f17d08f5797310990bb22662819ed106
Implements: blueprint ops-guide-rst
2016-03-10 03:28:44 +00:00
Gauvain Pocentek 4758bda39b Make sure that tox uses python2 by default
Our documentation tools are not python3 compatible, so make sure that
tox creates python2 virtual environments during tests.

Change-Id: I41e8ab8f3067928c4b38c48344cc029a3cad8996
2014-10-31 08:41:40 +01:00
Andreas Jaeger 178153c557 Use doc-tools-check-languages
Use new global language checking script and remove
test-languages.sh.

Change-Id: Ida42fb1b9e7d57f9697657cf90f1dc8874d9e28c
2014-08-18 20:57:23 +02:00
Andreas Jaeger e97c784060 Add new checklinks tox environment
Change-Id: If487b055e65942f411ac4bf4377ba81f230208cd
2014-08-16 12:05:05 +02:00
Andreas Jaeger 3140092730 Cleanup for translation
Remove non-existant option from test-languages.
Use test as parameter for buildlang target.

Change-Id: I4afd3b90f76c8fdff3d1be7917c11ef30e621a69
2014-07-07 18:56:24 +02:00
Andreas Jaeger b4a93f2de6 Rework translation tests
Rework test-languages so that we can test *all* languages as well
if needed and use the same script for both buildlang and testlang.
Add new tox job "publishlang" to publish all languages at once.

Change-Id: Ia8abe50ae798887ed62eaa8c81a4c7472021f718
2014-06-30 21:44:42 +02:00
Andreas Jaeger 6bb3b8f57a Create checklang tox.ini target
Create target to test that localized manuals are actually building.

Change-Id: Ia9ad298c4e9ee24f774e986d46c3c370d6046376
2014-05-15 16:43:56 -04:00
Andreas Jaeger d817058a38 Use xargs -0 instead of --null
This gives compatibility with OS X in the test.

Change-Id: I1768e7e7a76c94aaf78c0c11e07a7e60ed138664
2014-04-03 20:24:35 +02:00
Andreas Jaeger 6c24c72de4 Check that all po/pot files are valid
Perform minimal checks on po and pot files so that no broken files can
get imported.

Change-Id: I9b5edbad9f4302ca24e4255f503ee2db45ebd5d7
Co-Authored-By: Clark Boylan <clark.boylan@gmail.com>
Related-Bug: #1299349
2014-03-31 22:45:07 +02:00
Andreas Jaeger 132257a520 Create publishdocs target for publishing
tox -e publishdocs will be called by the post jenkins jobs to prepare
everything for publishing - and then the content of publish-docs
gets copied.

Change-Id: I9cdaf75ab7c5ec6bcc7df293ed0fc181434a5c2e
2014-02-14 16:18:32 +01:00
Andreas Jaeger 833c1e5aa3 Update for openstack-doc-tools 0.7
Rename generatedocbook, add  --nocreate-index to openstack-doc-test
run for publishing.

Change-Id: Icce080f8282f2a7220bb3531d74b7858e7a66be5
2014-02-14 07:23:44 +01:00
Jeremy Stanley f95a8592ea Remove tox locale overrides
* tox.ini: The LANG, LANGUAGE and LC_ALL environment overrides were
introduced originally during the testr migration in an attempt to be
conservative about the possibility that locale settings in the
calling environment could cause consistency problems for test runs.
In actuality, this should be unnecessary and any place where it does
cause issues ought to be considered an actual bug. Also, having
these in the configuration actively causes older pip to have
problems with non-ASCII content in some package metadata files under
Python 3, so drop it now.

Change-Id: Ib0759e47549050c377840397321cadf57a17aab7
Closes-Bug: #1277495
2014-02-10 03:07:32 +00:00
Andreas Jaeger d5198b1c21 Update for doc-tools 0.6
We can do now everything in the tox file and thus minimize the
content in the jenkins file.

This needs sitepackages set since gneratedocbook needs xml2po
which cannot be installed in the venv. Since it's installed in
the system, let's use sitepackages.

Change-Id: I8c9d578c069ecd55ce9c6abe9e8d48e666962c20
2014-02-07 17:44:33 +01:00
Andreas Jaeger 4e949d8692 Remove generatedocbook from tox.ini
generatedocbook needs xml2po python module which is not available from
pypi - let's call generatedocbook from Jenkins directly for now until
we have a solution for this.

Change-Id: Ibabdef205743060598677e715d47640b3bd57007
2014-02-05 20:11:00 +01:00
Andreas Jaeger b0562c4260 Create tox jobs for translated manual
Create new job for building of translated manual.
The job needs version 0.5 of openstack-doc-tools to support the "-l"
flag.

Change-Id: I2cdbecb29783c4ee90b3a663f97ab0d593e1ccfe
2014-02-04 21:42:00 +01:00
Andreas Jaeger 69a434ad38 Allow passing arguments to tox
Pass extra arguments to tests.

This allows to run for example:
       tox -- --force

Also reorder elements of envlist.

Change-Id: I8595db1fb9ce685c85f76b94714b270ea34c9d7d
2014-01-03 10:43:48 +01:00
Andreas Jaeger c3a4fd596d Enable for gating with openstack-doc-tools
Add files to allow us gating via:
tox -e checkbuild
tox -e checkniceness
etc

Change-Id: I7b1754c94ebecf41683576a41b643bbe124b3b3e
2014-01-02 16:58:22 +01:00