Commit Graph

11 Commits

Author SHA1 Message Date
Stephen Finucane 5a82d7e9a2 Retire docs-specs
We haven't used this in a long time and with the transition of docs from
a project to a SIG, it's not likely to be used again going forward.

Leave the .zuul.yaml file with noop-jobs to allow this patch to merge.

Change-Id: I557bace8008cc3b4fc1f78264f93291c49f897ad
Signed-off-by: Stephen Finucane <sfinucan@redhat.com>
Depends-On: Ie3ed990df99057896130ed0f7d5cf6c07db8c962
2019-07-03 10:54:39 +01:00
Andreas Jaeger 6efa693f2a Fix sphinx invocation
We use now "tox -e docs" and the sphinx-build invocation was using the
wrong directory - fix it.

Also, add doctrees option.

Change-Id: I527a08565cdc876dc862f1a944de06eddb7c33c9
2018-12-06 08:36:43 +01:00
Doug Hellmann e6de5e7a88 use python3 in tox
Set basepython once in testenv and let the other environments inherit
the value.

Change-Id: I98aa7d500d2c3abe3f10b09b282ea550bec5f43c
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
2018-08-14 13:11:10 -04:00
Nguyen Hung Phuong 154df6365c fix tox python3 overrides
We want to default to running all tox environments under python 3, so
set the basepython value in each environment.

We do not want to specify a minor version number, because we do not
want to have to update the file every time we upgrade python.

We do not want to set the override once in testenv, because that
breaks the more specific versions used in default environments like
py35 and py36.

Change-Id: I7b65a9dbb394224550008f0feeb5a47bb743c208
2018-07-03 10:26:26 +07:00
Andreas Jaeger 1319f331d3 Allow building with python3
yasfb 0.6.0 has been released and works with python2 and python3, so we
can remove the basepython setting from tox.ini.

Require at least version 0.6.1 since that fixes a unicode bug.

Change-Id: Ia52a874a58b693d090e6921e4a3a2ff49345d8ba
2017-04-14 20:11:41 +02:00
Monty Taylor ec388af66b Fix sphinx warnings
Ensure pbr 2.0, which includes a number of bugfixes along with support
for Sphinx 1.5's 'warning-is-error' option is used. Then suppress
"WARNING: nonlocal image URI found" - which gets triggered by our
inclusion of badges in the README.

Change-Id: I1901ec7d19f4d13ef6c8b814243786fb23e70b78
Co-Authored-By: Stephen Finucane <sfinucan@redhat.com>
2017-04-11 13:39:13 +01:00
Matthew Kassawara c9c3b5f69d Convert warnings to errors for local builds
For local builds, call sphinx-build directly with -W
rather than assuming pbr works correctly.

Change-Id: Ic9ecddc7b54529dbf23900a3fde871de454b9b8d
2016-02-01 07:57:54 -07:00
Andreas Jaeger c161e92da4 Sync with global requirements
Update to get the same versions in that are used elsewhere.

Version change for: pbr, testtools
Updated ../docs-specs/requirements.txt:
    pbr>=0.6,!=0.7,<1.0            ->   pbr>=1.3,<2.0
    testtools>=0.9.36,!=1.2.0      ->   testtools>=1.4.0

Also, stop specifying requirements.txt in tox.ini.

As PBR already injects the contents of requirements.txt into
setup_requires, there is no need for tox to explicitly install them.
http://lists.openstack.org/pipermail/openstack-dev/2015-July/069663.html

Change-Id: Id4ed6e53bcf199e78a02a5f5d079e2ca45642af4
2015-07-17 09:17:19 +02:00
Andreas Jaeger 6f8d3a3377 Use doc8 properly for testing in the gate
The gate calls build_sphinx explicitly without using tox and calls
tox -e py27. Add the doc8 tests to the default testenv so that it gets
really run.

Change-Id: I8310bb70d4b91ddcf45ecc0905c32e9b57ac69b2
2014-11-11 20:47:41 +00:00
Christian Berendt b22708b128 Check for style issues with doc8
Change-Id: I19cf54de04c0a9994228e620070aed8c7cf687de
2014-08-28 13:36:54 +02:00
Anne Gentle b5cea5db59 Initial docs-specs repository
Contains just template for now for discussion
2014-06-27 07:32:02 -05:00