Commit Graph

8 Commits

Author SHA1 Message Date
James E. Blair 6acbcbb2f9 Correct tagged version docs build
A variable reassignment in conf.py caused errors when we try to build
release versions of docs.  Correct that by swapping the order of use
and assignment.

Change-Id: Ica90e9c0cc20aa590ad0177a0ceab72f4f4c6b5b
2022-03-21 10:28:29 -07:00
James E. Blair 202ca394fb Switch docs theme to versioned RTD
To match change I2870450ffd02f55509fcc1297d050b09deafbfb9 in Zuul.

Change-Id: Ic23dcbc743ca1c79bcead8eebd2899c00e0750c6
2021-12-16 11:23:09 -08:00
Ian Wienand a5136b73ad Warn when autoroles doesn't find a README.rst
This modifies autoroles to raise a warning when it finds a role
without a README.rst file.  This can be disabled with a config option
if you wish to build with warning-as-error but don't wish to document
roles.

Fix a typo in the readme for the zuul_role_paths

Add a test for the autoroles path detection by including a roles
directory under a subdir.  Manually removing the README.rst file has
validated that the warning is triggered.

Change-Id: Ia64298e6e910d21eb6f3830dd8b42e40e3444fa8
2018-08-24 14:09:22 +10:00
James E. Blair 064feaa430 Add logo to docs
Change-Id: Id99b12f30c39eeaabf4696555c92ee4fae3a2f82
2018-05-04 14:52:18 -07:00
James E. Blair 27322342f2 Import directives/roles from zuul
This imports the current directives from Zuul itself, and adds
an example doc page that exercises them all so this repo is more
self-testing.

Also, use python3 by default to ensure we remain py3 compat.

Change-Id: Ie5b3cedd5e8dfaf0763d09a901fc9ba0e5b63683
2017-08-07 16:45:27 -07:00
James E. Blair 553fdce0cf Change usage from zuul_sphinx.zuul to zuul_sphinx
Change-Id: I6ca81675981a653cbf403b4870550d5b9b46a793
2017-08-04 16:22:26 -07:00
James E. Blair 4eaed1f585 Fix package setup
Sphinx and pbr are run-time requirements of this package.

Remove dep on oslosphinx.

Tell pbr our package name.

Change-Id: Ia23cb2845b4d482888637728ac7712358e5e3629
2017-07-31 14:00:10 -07:00
James E. Blair 7342ef9e80 Initial commit
Copied from openstack-infra/zuul-jobs repo.

Change-Id: If76b2313dc54557d6271dbaba8d8bb555ed5eae8
2017-06-16 10:38:17 -07:00