8 Commits

Author SHA1 Message Date
Darragh Bailey
753b3b46dc Use sphinx extlinks to shorten links to Jenkins wiki
Reduce the links to the Jenkins wiki for references to plugin pages by
using the sphinx.ext.extlinks module to provide a custom alias for
generating links using the same base url.

Change-Id: Ifba460cd131b4630deb41356e2b32641efe3086a
2015-02-24 21:37:17 +00:00
Darragh Bailey
302255ac60 Check external documentation links are valid
Use sphinx's linkcheck builder to validate any external links.

Fix the broken links by converting the example link to a code segment
and correcting the link referencing the cgit mirror for the git clone
instructions.

Change-Id: Ic6236e250b7af5c7c000af1e67fb69dd720ad6d8
2015-02-24 21:36:54 +00:00
Khai Do
d18c3cb1f5 Add usage info to JJB documentation
Display the usage info for JJB and add it to the
sphinx docs.

Fixes bug 1221944

Change-Id: I5b36cca7a836b009bfb0ca880abbccd4477de307
2013-09-09 15:14:18 -07:00
Antoine Musso
a11016979d sphinx is now stricter
The documentation files often have minor typo or badly formatted
commands which makes sphinx emits a warning. To make sure we always
catch them via the Jenkins build, this patch makes sphinx to convert
warning to errors thus aborting the build, simply add to pass the -W
option to sphinx-build.

This patch also fix one warning:
* There is no source/_static dir so disable html_static_path

Test plan:

$ make clean; make html
rm -rf build/*
sphinx-build -b html -d build/doctrees  -W source build/html
Making output directory...
Running Sphinx v1.1.3
loading pickled environment... not yet created
building [html]: targets for 18 source files that are out of date
updating environment: 18 added, 0 changed, 0 removed
reading sources... [100%] zuul
looking for now-outdated files... none found
pickling environment... done
checking consistency... done
preparing documents... done
writing output... [100%] zuul
writing additional files... genindex py-modindex search
copying static files... done
dumping search index... done
dumping object inventory... done
build succeeded.

Build finished. The HTML pages are in build/html.
$

Change-Id: I55935fb5e869919ac639f841876aaf3871c71d17
Reviewed-on: https://review.openstack.org/16328
Reviewed-by: Paul Belanger <paul.belanger@polybeacon.com>
Reviewed-by: Monty Taylor <mordred@inaugust.com>
Reviewed-by: Jeremy Stanley <fungi@yuggoth.org>
Reviewed-by: James E. Blair <corvus@inaugust.com>
Approved: Clark Boylan <clark.boylan@gmail.com>
Reviewed-by: Clark Boylan <clark.boylan@gmail.com>
Tested-by: Jenkins
2013-01-15 18:32:46 +00:00
Paul Belanger
c6bae32bd9 Update man_pages name to jenkins-jobs
This is mostly for our packaging efforts, and now will allow a user to
do:

  $ man jenkins-jobs

to access the documention.

Change-Id: Ie9fe43021dd5c5c8cd9fe07e457fb7d8db45f083
Signed-off-by: Paul Belanger <paul.belanger@polybeacon.com>
Reviewed-on: https://review.openstack.org/16555
Reviewed-by: James E. Blair <corvus@inaugust.com>
Approved: Jeremy Stanley <fungi@yuggoth.org>
Reviewed-by: Jeremy Stanley <fungi@yuggoth.org>
Tested-by: Jenkins
2012-11-20 22:55:20 +00:00
Paul Belanger
95cafc8bb0 Add openstack-common support for setup and version
With help from clarkb in #openstack-infra and openstack-ci/gerritbot,
I've manage to update our versioning to be inline with other openstack
projects. This is another step towards creating our OS packaging.

Change-Id: If3f44b939ee0a3c9c4dfa1d9f83ae14a8285ba5f
Signed-off-by: Paul Belanger <paul.belanger@polybeacon.com>
Reviewed-on: https://review.openstack.org/15335
Reviewed-by: Jeremy Stanley <fungi@yuggoth.org>
Reviewed-by: James E. Blair <corvus@inaugust.com>
Approved: Monty Taylor <mordred@inaugust.com>
Reviewed-by: Monty Taylor <mordred@inaugust.com>
Tested-by: Jenkins
2012-11-10 23:36:16 +00:00
Manuel Desbonnet
f05c9a3375 Add additional search path to fix building of documentation.
Sphinx was unable to find the jenkins_jobs.sphinx.yaml module when I
ran 'make html' in the doc/ subdirectory.

Change-Id: I64817139b149c66b01e3610248b49f955c5bde8c
Reviewed-on: https://review.openstack.org/13707
Reviewed-by: James E. Blair <corvus@inaugust.com>
Reviewed-by: Clark Boylan <clark.boylan@gmail.com>
Approved: James E. Blair <corvus@inaugust.com>
Tested-by: Jenkins
2012-10-05 19:58:04 +00:00
James E. Blair
ab7c6bc6c1 Add documentation.
Move test.sh to the tools directory.
Move parameters and notifications to their own modules; even
though they are implemented as Jenkins properties, they make
more sense as separate entities in the job builder, because
that's they way they are specified in the YAML.  All three
modules that touch the properties xml object know how to
create it if it's missing.

Change-Id: I4b42ff10a93fd3ed98f632b58e47f3e0e45086d6
Reviewed-on: https://review.openstack.org/12741
Reviewed-by: Clark Boylan <clark.boylan@gmail.com>
Approved: James E. Blair <corvus@inaugust.com>
Tested-by: Jenkins
2012-09-17 20:25:38 +00:00