With sphinx release of 5.0.0, they changed default for language variable
to 'en' from None. With that current None valuable is not valid and should
not be used.
Change-Id: I2ead74d2f14dc9364243c919fddba110864ca6f1
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: I815908dbaeb427fcb607e6f931d004e2112868ed
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: I4a2468490b4b1a4c33f06d708a4e471f9c2c2ba6
This repo is now testing only with Python
3, so let's make a few cleanups:
- Remove setup.* files, they are not needed
for this repo
- Cleanup */source/conf.py to remove now
obsolete content.
- Remove install_command, the default is fine;
move constraints into deps
Depends-On: https://review.opendev.org/720558
Change-Id: Ic6ea57d750a203b5a8f199b78dd3c0889b849df9
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: Icd376e16ba69ff3497ac86a71df2145402a49049
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: I167f72fd1cc8449f2e5849dad8ff6cf746c9bb21
Currently when clicking on the small bug in the roles'
docs, we land on openstack-manuals launchpad.
This should solve it.
Change-Id: Ieae5cbcdea15e46efe634e11583f1044223c2380
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: I233f688e00481251603a4dabbf7c6c5e6b3a6815
This commit refactors the current docs in the rsyslog_client role.
Moving forward, specific project configurations are maintained
in the appropriate role book.
Change-Id: Icd79ac494ecfe5ee0efd69db6b6e1071e7cd3be2
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: I69fbf2b53e8f40c2e08373a91ee5ce1eac8c33ce
As discussed during the Newton design summit, we
agreed to adopt the role documentation pattern laid
out in the os_keystone role
Change-Id: I43a21c3f9fe8dbf50f0f16c2c172c1aeff2fc173
The change moves the role out from the main repo rsyslog_client
repository and into its own standalone repository.
Items within this change:
* The role has been updated to ensure it runs standalone.
* Tests added to the role within tox.
* Functional tests added to the role that can either be run
via the run_tests.sh script or using tox.
* dev requirements have been updated for testing usecases.
* Docs added to both the README.rst file as well as the docs
folder.
Signed-off-by: Kevin Carter <kevin.carter@rackspace.com>
Dmitriy Rabotyagov