15 Commits

Author SHA1 Message Date
Clark Boylan
d07025f43f Switch documentation to alabaster theme
These are OpenDev docs now so the OpenStack theming doesn't quite fit.
Switch to Alabaster + OpenDev logo which is what we did with
infra-manual.

Change-Id: Id211e8e0b4dab7282fb5ca5fce494a028a826fba
2020-04-09 13:22:43 -07:00
Andreas Jaeger
62e76b5177 Docs: Update main page for OpenDev
Update conf.py and index.rst for OpenDev.

Use newer openstackdocstheme and update conf.py for this.

Change-Id: I62312ca1d3fda9221660b7bb664c8ea55dac68a4
2020-03-22 19:14:51 +01:00
Ian Wienand
b99c4c6fb0 Generate roles documentation
Since we're building out roles in system-config now, generate
documentation.  We look in roles/* and playbook/roles/* (follow-on
changes will split things up between the two).

Correct the reference names in the exim documentation to avoid
warnings and failure.

This also revealed a single unicode character in the exim readme
(which caused prior versions of zuul-sphinx to barf).  For fun, see if
you can find it!

Depends-On: https://review.openstack.org/#/c/579474/
Change-Id: I243a96bbd6d09560f8aa80b6345b90039422547a
2018-08-23 14:49:50 +10:00
Ian Wienand
882b730fdf Update to openstackdocstheme
This modernises the openstack-infra documentation by switching to
openstackdocstheme.  Update dependencies as required.

To remove non-relevant stuff from conf.py, I have just taken the demo
file from openstackdocstheme and lightly modified it.

It seems later sphinx has included it's own ":file:" role which now
conflicts.  Change it it ":cgit_file:" in our documentation.  Remove
the custom header template which no longer applies.  Add the
post-2.0-pbr sphinx-based warning-as-error, which fixes the original
problem that I actually noticed that errors could slip through the
gate tests :)

Change-Id: Ic7bec57b971bb4c75fc839e7269d1f69a576b85c
2018-06-25 11:19:43 +10:00
Anita Kuno
8549f5d29e Rename config => system-config in docs
We are renaming the openstack-infra/config repo to
openstack-infra/system-config. This patch edits the docs files.

Change-Id: Ic594f1b5438a400fb6c1071c3045adb7a0b7e441
2014-10-17 15:05:29 -04:00
Doug Hellmann
8983c64b0d Turn off manpage building
This repository doesn't need manual pages built, and the build fails
because of what appears to be a bug in docutils 0.12. Turn off manual
page building to avoid errors in the doc publishing job.

Change-Id: Icce0b3ac7e6dbe106b647ef37a317508e667bfd6
2014-08-27 15:30:56 -04:00
Elizabeth K. Joseph
51102141e3 Update ci.openstack.org footer
Update footer for ci.openstack.org for copyright and clarification
as to what repo to edit for the documentation.

Change-Id: I0466827a66e800fb1d20f1508cf2e6ffe1b8369e
2014-07-17 05:57:11 -07:00
Andreas Jaeger
233016e6d5 Rename oslo.sphinx to oslosphinx
oslo.sphinx has been renamed to oslosphinx.

This patch does not touch tools/atc/email-stats.sh
since it will be removed soon.

Closes-Bug: #1277168
Change-Id: Ib446323e26e4a66cb045f7de9b6269cc137eb61f
2014-02-24 20:07:29 +01:00
Monty Taylor
eef4f76011 Clean up flake8 issues before switch
In anticipation of swtiching to flake8 as part of the removal of
pyflakes jobs, clean up a few flake8 errors so that we don't have to
ignore as many things.

Change-Id: Idb8466bb3194904d84e17dd3f2a7c32aff13788c
2013-09-20 14:37:30 -07:00
Doug Hellmann
e6fb0aa640 Use the new oslo.sphinx library for the doc theme
Change-Id: I6b7557efec8d41687e4ef8a4864d1422bdebcfc5
Signed-off-by: Doug Hellmann <doug.hellmann@dreamhost.com>
2013-07-22 11:50:39 -04:00
Doug Hellmann
6b3a8c542d add openstack theme
Change-Id: Iae4c09ee950fa3617c6fc2b990bc26d0a50367ec
Signed-off-by: Doug Hellmann <doug.hellmann@dreamhost.com>
Reviewed-on: https://review.openstack.org/32628
Reviewed-by: Jeremy Stanley <fungi@yuggoth.org>
Approved: James E. Blair <corvus@inaugust.com>
Reviewed-by: James E. Blair <corvus@inaugust.com>
Tested-by: Jenkins
2013-06-13 23:40:57 +00:00
James E. Blair
9ed2be3098 Refactor project infrastructure docs.
The goal is to re-orient the documentation as an introduction for new
contributors and a reference for all contributors.

Change-Id: I8702a5ace908c7618a6451bbfef7fc79b07429ff
Reviewed-on: https://review.openstack.org/30515
Reviewed-by: Elizabeth Krumbach Joseph <lyz@princessleia.com>
Reviewed-by: Clark Boylan <clark.boylan@gmail.com>
Approved: Monty Taylor <mordred@inaugust.com>
Reviewed-by: Monty Taylor <mordred@inaugust.com>
Tested-by: Jenkins
2013-05-30 17:27:07 +00:00
Elizabeth Krumbach
4df9996990 Docs update: puppet does mysql install for gerrit
Change-Id: If88889554913f8f8dbd91d4455e0a91926e8bd5f
Reviewed-on: https://review.openstack.org/19313
Reviewed-by: Monty Taylor <mordred@inaugust.com>
Reviewed-by: shengjie min
Approved: Jeremy Stanley <fungi@yuggoth.org>
Reviewed-by: Jeremy Stanley <fungi@yuggoth.org>
Tested-by: Jenkins
2013-01-09 17:43:07 +00:00
Monty Taylor
74460853d1 Rename CI to Infra in MANY MANY places.
Change-Id: I409bd50ae374e0288531f07cfeea34856c5f8067
Reviewed-on: https://review.openstack.org/17319
Approved: James E. Blair <corvus@inaugust.com>
Reviewed-by: James E. Blair <corvus@inaugust.com>
Tested-by: James E. Blair <corvus@inaugust.com>
2012-12-16 17:30:47 +00:00
Clark Boylan
607b2db8c7 Use Jenkins Job Builder to config ci-docs job.
The existing ci-docs job is a one off job that was configured by hand.
Define the ci-docs job as a Jenkins Job Builder job using the existing
project-docs utilities.

To make the existing utilities work within the puppet repo the doc files
have been moved to doc/source, setup.cfg added to build docs in the new
dir, setup.py builds openstack-ci-puppet (instead of nova), tox now has
a venv virtualenv, and the .gitignore has been updated appropriately.

Change-Id: Ic0f291af181b4ef8eff62c5ec7cf3ccfa5b79800
Reviewed-on: https://review.openstack.org/13729
Approved: James E. Blair <corvus@inaugust.com>
Reviewed-by: James E. Blair <corvus@inaugust.com>
Tested-by: Jenkins
2012-09-27 16:50:32 +00:00