The subunit.test_results module is no longer imported by the top-level
subunit module and we have to explicitly import it.
This also fixes the broken doc build caused by the history.rst file.
The change log is now maintained differently so we don't need it
any more.
Closes-Bug: #2045766
Change-Id: Iae1ae0c55b8e1660a2bb41379a1f8f8506679cca
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.
Story: 2006070
Task: 35468
Change-Id: I1d1448153fceece36470547b5f1b646e194dc51d
Switch to openstackdocstheme 2.2.1 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.
Disable openstackdocs_auto_name to use 'project' variable as name.
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.
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: If9a4d4ca32793fef56b3e5c9a6508f7383476558
This commit adds deprecation comments to README, the user doc and
warning message to in the command. We already switched to use
`stestr` command instead of `ostestr`. And we haven't maintained
this command recently. So, it would be good to make it clearer for
users.
Change-Id: I3a6084db9f86627e3e94abaa4fb4aec52a01126a
As part of the docs migration work[0] for Pike we need to switch to use the
openstackdocstheme.
[0] https://review.openstack.org/#/c/472275/
Change-Id: Ibb797e7a004f9a4c29ea38bb8e1f66000c105b0f
This commit fixes some typos and changes 'regexp' to 'regex'. I think
'regexp' is also correct. However, in ostestr, they are mixed. So users
may be confused with it. So let's fix it.
Change-Id: I6c9042527707315f5dbb56f4a406327668c57d04
--whitelist_file, --blacklist_file is an unusual argument,
because of the underscore usage instead of
--blacklist-file/--blacklist-file .
Adding support for the '-' variant, and documenting only the
the '-' variant in the rst.
Change-Id: I8cc8197719f45bcfc05dc9412a03b9b1fe69e722
Adding option for reject regexp,
it works like any entry in the black list file,
so after the basic test selection regexp (including the white list),
the test cases satisfying the black-regexp search condition
will be removed from the final test list.
Change-Id: Id9fecf4aaa799828ae38b31ff3a4798763edfdd1
This commit fixes some doc warnings and disables the smarty-pants
function. The html_use_smartypants function renders '--' to '–'(–)
but it's not good for command options.
Change-Id: Iab0a93db86f46f26b074ca3e9904fd5ff1b0f533
The problem with TODO files is they require constant commits to keep
up to date, and this rarely happens. As is the case here where this
file is now quite stale and hasn't ever been updated. This commit
just drops the file in favor of just using launchpad as our task
tracking solution.
Change-Id: Id576d0f4dab2ecaf28db93909b7860306898a759
When the generate-subunit command was added to os-testr we neglected
to add documentation for the new command, this commit addressed that.
Change-Id: Ie643ecd2eb5faa98bfae921a9d9f96a33c7d43ba
This commit switches the docs to use the PBR generated ChangeLog
instead of a hand curated release notes section. This is a lot less
error prone and instantaneous as compared to our current method which
often leaves the release notes section stale for months at a time.
Change-Id: Iff6586fc0113fd8292967a536d5bd37cb46ec29d
This commit adds real docs for using the 3 currently packaged commands
in the os-testr project. As part of this change it also updates the
sphinx config to generate proper man pages for all the tooling. At a
future stage we need to ensure that these get installed properly.
Change-Id: I0055c7961203a094590f6cfeb136a2236a2f65cc
This commit adds a TODO file to the project to indicate both short and
long term work items for the project.
Change-Id: I90c19330eb5d8216a88f40411ed883e6f64c750d