7 Commits

Author SHA1 Message Date
Joshua Hesketh
1adaee4408 Replace github link with published spec
Change-Id: I497132fbe107019184b657645df78cc2c7d08258
2016-11-03 12:13:28 +11:00
Nish Patwa
3822cff64b [DOCS] Added release-name as a watermark to Docs.
Added a water mark to the role documentation
to make clear to deployers which release they're
working with.

Modified conf.py that adds watermark to the documentation according
to particular branch. If the current branch is master than
watermark is 'Pre-release' and if the current branch is
stable/<release-name> than watermark is <release-name>.

This is a combined implementation based on the following
patches:
- https://review.openstack.org/372565
- https://review.openstack.org/382637
- https://review.openstack.org/384140

Change-Id: Id0bab5c90d119bec40d1c745203d0c89ad7096f3
2016-10-18 17:09:57 +00:00
Robb Romans
ca416a4538 [DOCS] Syntax updates to the docs
Finish moving to new format, remove tags, fix RST titles, fix line
lengths, add link, indent example file, fresh coat of wax.

Change-Id: Ibcf3d5743c9b70d4f29ea8181d54a6c5c1974580
2016-08-25 01:13:56 +00:00
Alexandra
d96baff8be [DOCS] Move ironic docs to roles
Change-Id: I5c5a72d89074caf7afd1f801c8c523b24fe96e66
2016-08-11 20:26:36 +00:00
Jesse Pretorius
3f96ca867d Ensure that doc linting is included in the linters test
The 'docs' tox target executes the doc8 lint test which may result in
failures when testing documentation builds, but OpenStack-CI does not
execute that tox target.

In order to ensure that we catch all standard documentation syntax
errors and prevent them from merging, this patch includes the docs
target in the 'linters' chain of tests.

Fixes for any failures which result from executing this test are also
included in the patch.

Change-Id: I33eaae97d9e2bc6da6197db67d82e9aa8737e766
2016-07-26 00:39:31 +01:00
Jesse Pretorius
ad97caea63 Update sphinx configuration
This patch updates the sphinx configuration for docs and releasenotes
to make it easier to replicate across repositories and to comply with
pep8 testing without exceptions.

Change-Id: I2b46927a22150d2a0d21fdec73eb404114cbdb7e
2016-07-12 16:53:12 +01:00
Jesse Pretorius
a200b5b3b3 Add required base test configs
This patch adds some extra configurations required in order for
tests on OpenStack-CI to work.

It also adds some basic changes to document content.
2016-01-05 13:28:19 +00:00