summaryrefslogtreecommitdiff
AgeCommit message (Collapse)Author
2018-10-29Merge "Use tox-docs directly"HEADmasterZuul
2018-09-28Add attr-overview directive0.3.0Ian Wienand
This directive creates a bullet-point list of all the attributes defined within a file. The idea is to give a quick overview reference for config file options. There are two options to start with -- maxdepth is similar to the TOC option and only shows certain levels of options; prefix allows to filter down to a smaller set of options if required. I've reworked the documentation examples as part of testing this. The various components are moved into separate files. On the main page, moved the config options into the main documentation (and use the zuul attributes :) and pointed out that you can view the source of each sample page to see how to generate what you see. Change-Id: I6b0f414f50428c6e04b3aeb2a2c1f9196de80ce6 Notes (review): Code-Review+2: James E. Blair <corvus@inaugust.com> Code-Review+2: Tobias Henkel <tobias.henkel@bmw.de> Workflow+1: Tobias Henkel <tobias.henkel@bmw.de> Verified+2: Zuul Submitted-by: Zuul Submitted-at: Fri, 12 Oct 2018 04:16:24 +0000 Reviewed-on: https://review.openstack.org/604980 Project: openstack-infra/zuul-sphinx Branch: refs/heads/master
2018-09-26Add example and type options to attributesIan Wienand
As described; this is used in the nodepool configuration documentation. Change-Id: Iad188fd69818762cc9bad927beaff55749e0385c Notes (review): Code-Review+2: Tobias Henkel <tobias.henkel@bmw.de> Code-Review+2: James E. Blair <corvus@inaugust.com> Workflow+1: Tobias Henkel <tobias.henkel@bmw.de> Verified+2: Zuul Submitted-by: Zuul Submitted-at: Thu, 11 Oct 2018 19:22:45 +0000 Reviewed-on: https://review.openstack.org/604267 Project: openstack-infra/zuul-sphinx Branch: refs/heads/master
2018-09-26Use OrderedDict for object trackingIan Wienand
This makes iterating over the dict consistent on all python versions, which is important if we're extracting them for a contents list or similar. Change-Id: I1a23bfc8fd032dd545cc48302ef469006b1f7a1e Notes (review): Code-Review+2: James E. Blair <corvus@inaugust.com> Code-Review+2: Tobias Henkel <tobias.henkel@bmw.de> Workflow+1: Tobias Henkel <tobias.henkel@bmw.de> Verified+2: Zuul Submitted-by: Zuul Submitted-at: Thu, 11 Oct 2018 19:22:44 +0000 Reviewed-on: https://review.openstack.org/605240 Project: openstack-infra/zuul-sphinx Branch: refs/heads/master
2018-09-13Use tox-docs directlyAndreas Jaeger
Use tox-docs instead of build-tox-docs template that is defined in openstack-zuul-jobs. Change-Id: I7c7679277184f95f851c8db3208a8f43f03bc7c4 Notes (review): Code-Review+2: Tobias Henkel <tobias.henkel@bmw.de> Code-Review+1: wangqi <wang.qi@99cloud.net> Code-Review+2: Jeremy Stanley <fungi@yuggoth.org> Workflow+1: Jeremy Stanley <fungi@yuggoth.org> Verified+2: Zuul Submitted-by: Zuul Submitted-at: Mon, 29 Oct 2018 12:25:29 +0000 Reviewed-on: https://review.openstack.org/602252 Project: openstack-infra/zuul-sphinx Branch: refs/heads/master
2018-09-05Ignore non-directory entries in roles/0.2.5James E. Blair
The check for whether a README.rst exists would naively look for files like __init__.py/README.rst if there were files in the roles/ directory. Only look for role directories instead. Change-Id: I80268047a08b1294ccef841cd59894ec7133d16d Notes (review): Code-Review+1: Andreas Jaeger <jaegerandi@gmail.com> Code-Review+2: Clark Boylan <cboylan@sapwetik.org> Code-Review+2: Monty Taylor <mordred@inaugust.com> Workflow+1: Monty Taylor <mordred@inaugust.com> Verified+2: Zuul Submitted-by: Zuul Submitted-at: Wed, 05 Sep 2018 19:28:27 +0000 Reviewed-on: https://review.openstack.org/600135 Project: openstack-infra/zuul-sphinx Branch: refs/heads/master
2018-09-04Merge "Improve warning details"0.2.4Zuul
2018-09-04Improve warning detailsIan Wienand
Currently, if you make a warning mistake in your inline YAML you get warning output like: Warning, treated as error: /home/.../zuul.d:728:Unexpected indentation. This doesn't give you any clue as to what was actually wrong. Rework adding the content so that we add the job/template name as the source. You'll now get something like: Warning, treated as error: Job "failing-job" included in /home/.../doc/source/jobs.rst:6:Unexpected indentation. which lets you know the job/template that is causing the error, and where the auto include was sourced from. Change-Id: I3144cb9bf689724d113c9b4b126f975f34f565c3 Notes (review): Code-Review+2: Tobias Henkel <tobias.henkel@bmw.de> Code-Review+2: James E. Blair <corvus@inaugust.com> Workflow+1: James E. Blair <corvus@inaugust.com> Verified+2: Zuul Submitted-by: Zuul Submitted-at: Tue, 04 Sep 2018 22:46:56 +0000 Reviewed-on: https://review.openstack.org/599469 Project: openstack-infra/zuul-sphinx Branch: refs/heads/master
2018-08-24Warn when autoroles doesn't find a README.rstIan Wienand
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 Notes (review): Code-Review+2: Monty Taylor <mordred@inaugust.com> Code-Review+2: Clark Boylan <cboylan@sapwetik.org> Code-Review+2: Tobias Henkel <tobias.henkel@bmw.de> Workflow+1: Tobias Henkel <tobias.henkel@bmw.de> Verified+2: Zuul Submitted-by: Zuul Submitted-at: Mon, 03 Sep 2018 12:10:41 +0000 Reviewed-on: https://review.openstack.org/596014 Project: openstack-infra/zuul-sphinx Branch: refs/heads/master
2018-08-22Merge "Update docs build job"Zuul
2018-08-21Update docs build jobAndreas Jaeger
Use tox -e docs for building with the new build-tox-docs template. Update tox.ini to use sphinx-build directly. Change-Id: Idd8110051a78f96ed28848ff9836ade3fa59329b Notes (review): Code-Review+2: Ian Wienand <iwienand@redhat.com> Code-Review+2: Monty Taylor <mordred@inaugust.com> Workflow+1: Monty Taylor <mordred@inaugust.com> Verified+2: Zuul Submitted-by: Zuul Submitted-at: Wed, 22 Aug 2018 11:32:04 +0000 Reviewed-on: https://review.openstack.org/594518 Project: openstack-infra/zuul-sphinx Branch: refs/heads/master
2018-08-20Add config option to find other roles0.2.3Ian Wienand
Add a new option to provide an additional list of directories to look for roles to document. Additionally, allow the 'roles/' top-level directory to not exist. Needed-By: https://review.openstack.org/593478 Change-Id: I997c8bbece4917fe041aa9fd3dde13ee532fa2a6 Notes (review): Code-Review+2: James E. Blair <corvus@inaugust.com> Code-Review+2: Monty Taylor <mordred@inaugust.com> Workflow+1: Monty Taylor <mordred@inaugust.com> Verified+2: Zuul Submitted-by: Zuul Submitted-at: Tue, 21 Aug 2018 21:30:14 +0000 Reviewed-on: https://review.openstack.org/593477 Project: openstack-infra/zuul-sphinx Branch: refs/heads/master
2018-08-20Open role readme files in utf-8 modeIan Wienand
I managed to get some hidden utf-8 characters into a zuul role README.rst file which broke building in the gate on python 2.7 in a rather mysterious way, deep inside the rst parser. Make sure we open the README.rst files in unicode mode; this way the lines are passed into the rst core as unicode and things go as planned. Change-Id: Id27062989c0527de545b18471eec29926955a4e4 Notes (review): Code-Review+2: Tobias Henkel <tobias.henkel@bmw.de> Code-Review+2: James E. Blair <corvus@inaugust.com> Workflow+1: James E. Blair <corvus@inaugust.com> Verified+2: Zuul Submitted-by: Zuul Submitted-at: Tue, 21 Aug 2018 21:01:28 +0000 Reviewed-on: https://review.openstack.org/579474 Project: openstack-infra/zuul-sphinx Branch: refs/heads/master
2018-07-12Stop publishing to docs.openstack.orgJames E. Blair
Change-Id: I115229c06b8372099125072be7b415a67fdea263 Depends-On: https://review.openstack.org/582322 Notes (review): Code-Review+1: Andreas Jaeger <jaegerandi@gmail.com> Code-Review+2: Tobias Henkel <tobias.henkel@bmw.de> Code-Review+2: James E. Blair <corvus@inaugust.com> Workflow+1: James E. Blair <corvus@inaugust.com> Verified+2: Zuul Submitted-by: Zuul Submitted-at: Tue, 17 Jul 2018 17:20:12 +0000 Reviewed-on: https://review.openstack.org/582326 Project: openstack-infra/zuul-sphinx Branch: refs/heads/master
2018-05-04Add logo to docsJames E. Blair
Change-Id: Id99b12f30c39eeaabf4696555c92ee4fae3a2f82 Notes (review): Code-Review+2: Tobias Henkel <tobias.henkel@bmw.de> Code-Review+2: Joshua Hesketh <josh@nitrotech.org> Workflow+1: Tobias Henkel <tobias.henkel@bmw.de> Verified+2: Zuul Submitted-by: Zuul Submitted-at: Tue, 15 May 2018 17:53:16 +0000 Reviewed-on: https://review.openstack.org/566413 Project: openstack-infra/zuul-sphinx Branch: refs/heads/master
2018-04-12Merge "Make the yaml parser aware of '!encrypted/' tags"0.2.2Zuul
2018-04-10Add build-sphinx check/gate jobsJames E. Blair
I accidentally removed this in an earlier restructuring. Change-Id: I913cd2e804985951b32ad442f5e9ab8488508e74 Notes (review): Code-Review+2: Tobias Henkel <tobias.henkel@bmw.de> Code-Review+2: Clark Boylan <cboylan@sapwetik.org> Workflow+1: Clark Boylan <cboylan@sapwetik.org> Verified+2: Zuul Submitted-by: Zuul Submitted-at: Thu, 12 Apr 2018 17:17:10 +0000 Reviewed-on: https://review.openstack.org/560090 Project: openstack-infra/zuul-sphinx Branch: refs/heads/master
2018-04-10Make the yaml parser aware of '!encrypted/' tagsFelix Schmidt
Currently, the documentation generation for zuul jobs fails whenever a secret is included in any of the yaml files that are parsed by the zuul-sphinx extension. This is because the yaml parser is not aware of the custom tag '!encrypted/pkcs1-oaep' and therefore fails to initialize an appropriate python object due to a missing constructor. This results in the following error message: "yaml.constructor.ConstructorError: could not determine a constructor for the tag '!encrypted/pkcs1-oaep'" Change-Id: Id011487615a3392affd627bbdcbdbe18e58206c5 Notes (review): Code-Review+2: Tobias Henkel <tobias.henkel@bmw.de> Code-Review+2: Monty Taylor <mordred@inaugust.com> Code-Review+2: James E. Blair <corvus@inaugust.com> Workflow+1: Tobias Henkel <tobias.henkel@bmw.de> Verified+2: Zuul Submitted-by: Zuul Submitted-at: Thu, 12 Apr 2018 19:44:46 +0000 Reviewed-on: https://review.openstack.org/559963 Project: openstack-infra/zuul-sphinx Branch: refs/heads/master
2018-03-22Publish docs to zuul-ci.orgJames E. Blair
Also, move the publish-to-infra job into this repo for consistency. Change-Id: I05275f167cfa114df9e437cf8730fe7ab8d6192b Notes (review): Code-Review+2: Tobias Henkel <tobias.henkel@bmw.de> Code-Review+2: David Shrewsbury <shrewsbury.dave@gmail.com> Workflow+1: David Shrewsbury <shrewsbury.dave@gmail.com> Verified+2: Zuul Submitted-by: Zuul Submitted-at: Fri, 23 Mar 2018 17:43:22 +0000 Reviewed-on: https://review.openstack.org/555501 Project: openstack-infra/zuul-sphinx Branch: refs/heads/master
2017-10-18Fix error in job parser0.2.1James E. Blair
Change-Id: Id806d3648ad7464a2e6d1ae1235061f48014a49a Notes (review): Code-Review+2: Clark Boylan <cboylan@sapwetik.org> Workflow+1: Clark Boylan <cboylan@sapwetik.org> Verified+2: Zuul Submitted-by: Zuul Submitted-at: Wed, 18 Oct 2017 23:19:30 +0000 Reviewed-on: https://review.openstack.org/513201 Project: openstack-infra/zuul-sphinx Branch: refs/heads/master
2017-10-16Add support for project-templates0.2.0James E. Blair
Change-Id: I0f86acd7fb5e049e5368249de52f9d81a99936d8 Notes (review): Code-Review+2: Monty Taylor <mordred@inaugust.com> Code-Review+2: Tobias Henkel <tobias.henkel@bmw.de> Code-Review+1: Andreas Jaeger <jaegerandi@gmail.com> Code-Review+2: James E. Blair <corvus@inaugust.com> Workflow+1: James E. Blair <corvus@inaugust.com> Verified+2: Zuul Submitted-by: Zuul Submitted-at: Tue, 17 Oct 2017 14:36:06 +0000 Reviewed-on: https://review.openstack.org/512449 Project: openstack-infra/zuul-sphinx Branch: refs/heads/master
2017-09-19Update exception message to include directoriesMonty Taylor
Change-Id: Ifa0f907973b24422acd28e7a84a31919cff5acee Notes (review): Code-Review+1: David Moreau Simard <dms@redhat.com> Code-Review+2: Tobias Henkel <tobias.henkel@bmw.de> Code-Review+2: James E. Blair <corvus@inaugust.com> Workflow+1: James E. Blair <corvus@inaugust.com> Verified+2: Jenkins Submitted-by: Jenkins Submitted-at: Wed, 04 Oct 2017 22:42:40 +0000 Reviewed-on: https://review.openstack.org/505400 Project: openstack-infra/zuul-sphinx Branch: refs/heads/master
2017-09-17Support zuul.d directories0.1.6Monty Taylor
Change-Id: I3a0cba537043ffbc554f1bb1cfe951d86587b014 Notes (review): Code-Review+1: Andreas Jaeger <jaegerandi@gmail.com> Code-Review+2: James E. Blair <corvus@inaugust.com> Code-Review+2: Tobias Henkel <tobias.henkel@bmw.de> Code-Review+1: David Moreau Simard <dms@redhat.com> Workflow+1: Tobias Henkel <tobias.henkel@bmw.de> Verified+2: Jenkins Submitted-by: Jenkins Submitted-at: Wed, 20 Sep 2017 03:14:12 +0000 Reviewed-on: https://review.openstack.org/504797 Project: openstack-infra/zuul-sphinx Branch: refs/heads/master
2017-08-11Add jobvar and rolevar directives0.1.5James E. Blair
Jobs and Roles frequently have the same variable names, so use create unique directives and roles for each so that they are easy to disambiguate. This lets us say :jobvar:`tox.environment` rather than :var:`job-tox.environment` which seems a bit arbitrary. Change-Id: I9d72d11bfdb700037a6a08f92a2dbfa95ee519ad Notes (review): Code-Review+2: Paul Belanger <pabelanger@redhat.com> Code-Review+2: David Shrewsbury <shrewsbury.dave@gmail.com> Workflow+1: David Shrewsbury <shrewsbury.dave@gmail.com> Verified+2: Jenkins Submitted-by: Jenkins Submitted-at: Mon, 14 Aug 2017 17:03:58 +0000 Reviewed-on: https://review.openstack.org/493248 Project: openstack-infra/zuul-sphinx Branch: refs/heads/master
2017-08-09Mark zuul-sphinx as supporting python30.1.4Monty Taylor
We test it and use it in python3, so go ahead and mark that in setup.cfg. Also, update the homepage to the zuul-sphinx docs. Change-Id: I27be701e0c74af88a8bbe317b3f753ed57892a5d Notes (review): Code-Review+2: James E. Blair <corvus@inaugust.com> Workflow+1: James E. Blair <corvus@inaugust.com> Verified+2: Jenkins Submitted-by: Jenkins Submitted-at: Wed, 09 Aug 2017 19:46:19 +0000 Reviewed-on: https://review.openstack.org/492203 Project: openstack-infra/zuul-sphinx Branch: refs/heads/master
2017-08-07Import directives/roles from zuulJames E. Blair
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 Notes (review): Code-Review+2: Paul Belanger <pabelanger@redhat.com> Code-Review+2: Monty Taylor <mordred@inaugust.com> Workflow+1: Monty Taylor <mordred@inaugust.com> Verified+2: Jenkins Submitted-by: Jenkins Submitted-at: Wed, 09 Aug 2017 16:41:15 +0000 Reviewed-on: https://review.openstack.org/491635 Project: openstack-infra/zuul-sphinx Branch: refs/heads/master
2017-08-04Change usage from zuul_sphinx.zuul to zuul_sphinx0.1.3James E. Blair
Change-Id: I6ca81675981a653cbf403b4870550d5b9b46a793 Notes (review): Code-Review+2: James E. Blair <corvus@inaugust.com> Workflow+1: James E. Blair <corvus@inaugust.com> Verified+2: Jenkins Submitted-by: Jenkins Submitted-at: Fri, 04 Aug 2017 23:34:39 +0000 Reviewed-on: https://review.openstack.org/491131 Project: openstack-infra/zuul-sphinx Branch: refs/heads/master
2017-08-04Add setup to module importJames E. Blair
This allows us to configure the extension as 'zuul_sphinx' rather than 'zuul_sphinx.zuul'. Change-Id: I8a1534f7c2614ee11411cf228de38931257fc970 Notes (review): Code-Review+2: Monty Taylor <mordred@inaugust.com> Code-Review+2: James E. Blair <corvus@inaugust.com> Workflow+1: James E. Blair <corvus@inaugust.com> Verified+2: Jenkins Submitted-by: Jenkins Submitted-at: Fri, 04 Aug 2017 23:22:57 +0000 Reviewed-on: https://review.openstack.org/491128 Project: openstack-infra/zuul-sphinx Branch: refs/heads/master
2017-07-31Remove cap on sphinx0.1.2James E. Blair
To make this more generally useful. Change-Id: I0a33215a87ca80c8ac23967b5459734ec027fe40 Notes (review): Code-Review+2: Paul Belanger <pabelanger@redhat.com> Workflow+1: Paul Belanger <pabelanger@redhat.com> Verified+2: Jenkins Submitted-by: Jenkins Submitted-at: Mon, 31 Jul 2017 23:21:58 +0000 Reviewed-on: https://review.openstack.org/489431 Project: openstack-infra/zuul-sphinx Branch: refs/heads/master
2017-07-31Fix package setup0.1.1James E. Blair
Sphinx and pbr are run-time requirements of this package. Remove dep on oslosphinx. Tell pbr our package name. Change-Id: Ia23cb2845b4d482888637728ac7712358e5e3629 Notes (review): Code-Review+2: Paul Belanger <pabelanger@redhat.com> Code-Review+2: Clark Boylan <cboylan@sapwetik.org> Workflow+1: Clark Boylan <cboylan@sapwetik.org> Verified+2: Jenkins Submitted-by: Jenkins Submitted-at: Mon, 31 Jul 2017 21:06:16 +0000 Reviewed-on: https://review.openstack.org/489395 Project: openstack-infra/zuul-sphinx Branch: refs/heads/master
2017-06-16Initial commit0.1.0James E. Blair
Copied from openstack-infra/zuul-jobs repo. Change-Id: If76b2313dc54557d6271dbaba8d8bb555ed5eae8 Notes (review): Code-Review+2: Monty Taylor <mordred@inaugust.com> Code-Review+2: James E. Blair <corvus@inaugust.com> Workflow+1: James E. Blair <corvus@inaugust.com> Verified+2: Jenkins Submitted-by: Jenkins Submitted-at: Fri, 16 Jun 2017 21:11:32 +0000 Reviewed-on: https://review.openstack.org/475041 Project: openstack-infra/zuul-sphinx Branch: refs/heads/master
2017-06-14Added .gitreviewOpenStack Project Creator