Removes yaml as a type of the code-block as the rendered
text was hardly readable.
Removes shell-session type of the code-block in case of showing
cat output - the output wasn't rendered at all.
Removes emphasize-lines as the emphasized lines were too bright
and therefore not readable - I found there are issues with
openstackdocstheme and Sphinx 3 [1] and I didn't find any simple
solutions - fixing just a few highlighted lines is not worth it.
A few typos were fixed as well.
[1] https://bugs.launchpad.net/openstack-doc-tools/+bug/1876343
Trying if rebuilding the doc solves the rendering issue:
https://docs.openstack.org/python-tempestconf/latest/user/usage.html
Change-Id: I83ebfdeb949bd0a6cfa99889cb9fbb56d8bcb218
Deprecated scenario image options are being removed from tempest,
see [1]. The tempest change makes img_dir obsolete
therefore CONF.scenario.img_file needs to contain the full path to
the image now.
CONF.scenario.img_dir will be removed entirely from tempest in the
near future by [2].
[1] https://review.opendev.org/c/openstack/tempest/+/710996
[2] https://review.opendev.org/c/openstack/tempest/+/754927
Change-Id: Icf7ac92807873d0a5cd8ccaf75033003adb21c0a
This patch enables building .pdf documentation using new 'pdf-docs'
tox environment. The newly created tox environment creates latex
source codes using sphinx-build and then builds the pdf
documentation using make.
The patch also fixes documentation to reflect change from openstack
to osf organization fixes copy-paste mistakes in the doc configs.
Change-Id: I15a03442c2a2c355c8e7f1658c1b2329eb38c7df
Switch to openstackdocstheme 2.2.0 and reno 3.1.0 versions. Using
these versions will allow especially:
* Linking from HTML to PDF document
* Allow parallel building of documents
* Fix some rendering problems
Update Sphinx version as well.
Remove docs requirements from lower-constraints, they are not needed
during install or test but only for docs building.
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.
Change-Id: I42b7a7d44fc50218f99f6106324945864b46d74f
Make a few cleanups:
- Remove python 2.7 stanza from setup.py
- Add requires on python >= 3.6 to setup.cfg so that pypi and pip
know about the requirement
- Remove obsolete sections from setup.cfg
- Update classifiers
- Update requirements, no need for python_version anymore
Drop rocky and queens jobs, those jobs are py27 and are not
supported here anymore.
Change-Id: I2e797d325c9427264ef3dbba7aca15936eb65cd1
Sync sphinx dependency with global requirements. It caps python 2 since
sphinx 2.0 no longer supports Python 2.7.
Change-Id: I4a4c07ffaacb65e9ee919fb7a0d25de3c0840e12
Because openstacksdk superseded os-client-config module, it is
recommended to use this module instead.
Story: 2002021
Task: 19662
Change-Id: I6f225416ff4791a00b04655614eb8f24bed8ae7b
The patch removes setting compute_feature_enabled.api_extensions
from tempest.conf as the extensions have been deprecated since
Tempest 14.0.
Story: 2005794
Task: 33521
Change-Id: I118c4ac1eac43db6b99605e830467b386be7c0b3
Thorough replacement of git.openstack.org and review.openstack.org URLs
with their opendev.org counterparts.
Change-Id: I1b07e63476a930e95e445686b674377fa959c25d
python-tempestconf sets _member_role by default, however,
the role is not created in devstack environment by default.
Therefore the patch adds logic which checks if the role is
present and if it's not, it tries to look for member role.
If the member role is not present as well, auth.tempest_roles
is not set at all.
Story: 2003550
Task: 24839
Change-Id: I0051bb4f870d58298403ac6fef6ae4ec454997af
The review adds an option for converting images to raw
format before they are uploaded to glance.
In some cases the boot of the image is faster when the
image is already in raw format.
Story: 2005454
Task: 30506
Change-Id: Ie7226ecaad8feaf0a0c416905cf3e2107d4e8cd3
python-tempestconf doesn't provide any way how to define a
different flavor memory and disk size but provides an option
for defining a custom image (not cirros which is default).
However, when using custom image the default flavor size is
not enough.
Therefore the review adds two arguments which can be used
for defining flavor minimum memory and minimum disk size.
The review also edits the documentation and fixes a few typos.
Change-Id: Iba14b65ff8e147765e47d223dea6231ab649135f
Story: 2001536
Task: 6341
The patch implements --profile argument, which defines a path to
a profile.yaml file - a file which contains python-tempestconf
arguments and their values.
Also --generate-profile argument is introduced. A user can generate
a sample profile.yaml file using this argument. The sample contains
definitions of all python-tempestconf arguments set to their default
values.
Story: 2004503
Task: 28225
Change-Id: I80848d8ef9868ed3975b938d61880753eadc5ae9
--append argument appends a value or values to the specified
section.key pair. It may be helpful in cases when a user wants
to add custom extensions to tempest.conf in an automated job.
Change-Id: I116f4456823913f21b5f8f01ff2b14d42ec67dc2
Story: 2004429
Task: 28088
As all of documenation parts were merged, this patch makes
sure, that all of them uses the same style for marking
commands, arguments, notes, ...
Also a few typos were fixed.
Change-Id: I0239e5241aa854f515fc2d72e7947dc51b3ecb56
Story: 2002703
Task: 22965
Add examples of usage of some discover-tempest-config
options, document what resources can be created and
what's needed for it
Change-Id: I78b499a79bc05e9c0528da573af78fd2b58df7f4
Story: 2002703
Task: 22885
Task: 22573
Document and show example how to integrate python-tempetsconf
with a different project.
Change-Id: I3757d298653dfb243d1b710759f9550a9e27c8a7
Story: 2002703
Task: 22574
Usage section is there twice, it's because the README.rst
is included in doc too and it contains usage section as well.
The patch fixes that by not including the README.rst and
copies the content of README.rst to the documentation,
in order to have at least some, while documentation is being
written or reviewed.
Change-Id: I0247289029cd63b354965242ce7c1eca65f945eb
Story: 2002703
Task: 22543
Bump the dependencies to something more up-to-date, move reno
to documentation requirements, which are now a dependency
for the releasenotes tox target (even if not needed on the gates).
Clean up the configuration options and one title.
Change-Id: I760d21a6420d2928e60792455b59bbe63a49a8ae
Implement optional cleanup to support the new PTI jobs for
documentation which won't use tox anymore.
Docs tox environment will still available for developers
but it is no loger used in the gate to construct the documentation.
See http://lists.openstack.org/pipermail/openstack-dev/2017-December/125710.html
Change-Id: I411115977f095e0e0ee01b65d01fe8c389a8754e
This commit starts using reno for tracking release notes and
documentation on the python-tempestconf project.
Change-Id: I26de978d4db7b6e67451be56dbf007a7918b4a7a
Martin Kopec
Andreas Jaeger
pengyuesheng
Lukas Piwowarski
Luigi Toscano
Chandan Kumar
Daniel Mellado
Chandan Kumar