18 Commits

Author SHA1 Message Date
Andreas Jaeger
86b600e541 Use newer openstackdocstheme and reno versions
The sync from https://review.opendev.org/733244 updated to
openstackdocstheme 2.2.1 and reno 3.1.0 versions.

Set openstackdocs_pdf_link to link to PDF file. Note that
the link to the published document only works on docs.openstack.org
where the PDF file is placed in the top-level html directory. The
site-preview places the PDF in a pdf directory.

openstackdocstheme renames some variables, so follow the renames
before the next release removes them. A couple of variables are also
not needed anymore, remove them.

See also
http://lists.openstack.org/pipermail/openstack-discuss/2020-May/014971.html

Change-Id: I5c6c99763cffd75824c31efd37caec6e4828ac43
2020-06-03 20:07:39 +02:00
Andreas Jaeger
a8a3ae3234 Update docstheme for style
New version of openstackdocstheme (Victoria+) respects pygments_style.
Since this repo is using now Victoria (master) requirements but has
not branched for Ussuri yet, it uses the new version.

Change pygments_style to 'native' since old theme version always used
'native' and the theme now respects the setting and using 'sphinx' can
lead to some strange rendering.

Change-Id: Iad5aa6453e61bf08555805072e9b6e433e656e93
2020-05-20 18:52:57 +02:00
Andreas Jaeger
b64f07b80d Cleanup py27 support
This repo is now testing only with Python 3, so let's make
a few cleanups:
- Remove setup.* files, those are not needed for this repo.
- Cleanup */source/conf.py to remove now obsolete content.
- Remove install_command from tox.ini, the default is fine,
  move constraints into deps
- Enable warnings for docs build

Change-Id: I07da37d6f15aefc7b2fa558a6ead7028d6c9c556
2020-04-27 19:57:02 +02:00
Dmitriy Rabotyagov
2332b70d4d PDF Documentation Build tox target
This patch adds a `pdf-docs` tox target that will build
PDF versions of our docs. As per the Train community goal:

  https://governance.openstack.org/tc/goals/selected/train/pdf-doc-generation.html

Add sphinxcontrib-svg2pdfconverter to doc/requirements.txt
to convert our SVGs.

Change-Id: I0b200d57d7c92c959dc90fc540653aed71a6778c
Story: 2006105
2019-10-16 11:26:05 +00:00
Mohammed Naser
60a85f691c docs: drop sphinxmark
sphinxmark is no longer compatible with the latest release of Sphinx
which is causing all of our documentation jobs to fail.  This patch
removes it as our current usage of openstacktheme for documentation
already provides watermarks for current branch and notices for which
branch the documentation covers.

Change-Id: I8db91976d1077ef1cc52485179900a4271940bcf
2019-04-04 05:05:05 +00:00
Jean-Philippe Evrard
a1d106e43c Remove pip_install dependency
With addition of pip_install on every node, we don't
need to have pip_install as a meta dependency.

Depends-On: If3412bb888ebb854874bbc43eb76bfcb3e4a7868
Depends-On: I79ff70c438b44753be2a93f004ebbc46de0a963d
Change-Id: I49847c9fe01c0d4fdf420dbc31985edc08650f2c
2017-12-05 11:56:48 +00:00
Jean-Philippe Evrard
17e5df0953 Initial OSA zuul v3 role jobs
This patch implements an initial set of jobs intended to match
the current job execution method. It does not intend to improve
how the jobs are executed - only to replicate what is currently
in openstack-infra/openstack-zuul-jobs and provide the platform
to iterate on.

Change-Id: I7a1c312268b7219cb3e04058e9563a2fe0c469f0
2017-10-17 20:22:53 +00:00
ZhongShengping
486e54aa8e Fix openstackdocstheme settings
To use openstackdocstheme 1.11.0 properly, this patch fixes
some settings according to follow[0].

[0]https://docs.openstack.org/openstackdocstheme/latest/

Change-Id: Ib2d216eeef4c78e0f9ff24d8b8e531fa2ad833c1
2017-07-03 16:50:23 +08:00
ji-xuepeng
bb6ab783c2 Use https instead of http for git.openstack.org
Trivialfix

Change-Id: I96d954332991745dcbaf6d5f0ec4ef50c41aba72
2017-02-06 21:57:18 +08:00
Andy McCrae
3f050ab3da Update repository with reference to role git location
Change-Id: Ie3c4ac3a58d7b1157f56193a42ab4e5bddf599a3
2016-12-22 14:26:23 +00:00
Jean-Philippe Evrard
306a78b409 Point roles docs bugs to openstack-ansible LP
Currently when clicking on the small bug in the roles'
docs, we land on openstack-manuals launchpad.

This should solve it.

Change-Id: I01efc2e73ad333984a65ef09875ecb86fecf2e29
2016-12-01 14:35:26 +00:00
Nish Patwa
3765feee65 [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: Iabd306e4598b100facdd34fa715439df72251d03
2016-10-18 16:26:31 +00:00
Robb Romans
7d3cce02c3 [DOCS] Move RabbitMQ role docs
Update the role documentation to match the new format. Each role project
should maintain the configuration variations for the role project
itself.

Change-Id: I73b061da40b08b327fc3445e073cbd8997920ccd
2016-08-12 12:01:48 -05:00
Major Hayden
e0f20a5723 Fix D005 error
The patch fixes the following documentation build error that
seems to be happening outside the CI jobs:

doc/source/index.rst:1: D005 No newline at end of file

Change-Id: I9ee6b6188223bbf29d8f668c60a58803ea42a2db
2016-07-22 20:06:41 -05:00
Jesse Pretorius
cfaf4f86bc 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: I389cf6c3490adb516cf90305393471b47f83a937
2016-07-12 16:55:02 +01:00
Travis Truman
5bc9647ebb [DOCS] Cleanup the role docs for consistency and clarity
Utilizing RST includes to reduce duplication of documentation
effort. All contents of the Ansible defaults/main.yml are
now included in the documentation directly.

Change-Id: Ib5224208259bc50b80cff2613f487ecbe461719a
2016-03-09 21:28:38 -05:00
Bjoern Teipel
a90cd7e343 Adding ERLANG VM tuning parameters
This fix will add ERLANG VM tuning parameters with increased
default settings to support larger installations.
Following overrides have been added:
  rabbitmq_async_threads defaults to 128 (from 32)
  rabbitmq_process_limit defaults to 1048576 (from 256k)

Closes-Bug: #1549940
DocImpact

Change-Id: Ia0fab288db8aa287e667dfc843f02d7ec318a816
2016-02-26 20:01:03 -06:00
Kevin Carter
ee03bfc5ba
first commit
Signed-off-by: Kevin Carter <kevin.carter@rackspace.com>
2015-12-09 09:25:11 -06:00