Commit Graph

34 Commits

Author SHA1 Message Date
Takashi Kajinami a4876f6d6d Fix compatibility with subunit >= 1.4.3
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
2023-12-20 23:23:58 +09:00
niuke 204fe38386 remove unicode from code
Change-Id: Iea91567941e16007750498114d279dde12571fb8
2022-09-21 08:22:13 +08:00
Ghanshyam Mann 6f10535042 Remove the deprecated ostestr command
ostestr command has been deprecated in June 2019
- I3a6084db9f86627e3e94abaa4fb4aec52a01126a

This command is replaced by the stestr. os_testr
repo which has other utilities also is not deprecated
and will continue to be maintained.

QA meeting discussion:
https://meetings.opendev.org/irclogs/%23openstack-qa/%23openstack-qa.2022-03-22.log.html#t2022-03-22T15:45:36

Change-Id: Ic0cddcc226f092ac6df405e83b2e7660d71d0ba2
2022-03-24 16:49:44 -05:00
Ghanshyam Mann 01b0955937 Update IRC network to OFTC
Change-Id: I8b9ec9a222ca674d0af4a350bcb0791a9ced38ec
2021-05-31 15:06:43 -05:00
Lukas Piwowarski 9bb54d2366 Create tox environment to build pdf documentation
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
2020-09-24 10:16:39 +02:00
Andreas Jaeger ea0e88e9ce Switch to newer openstackdocstheme and reno versions
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
2020-06-02 14:20:06 +02:00
Ghanshyam Mann ce1af65b21 [ussuri][goal] Update contributor documentation
This patch updates/adds the contributor documentation to follow
the guidelines of the Ussuri cycle community goal[1].

[1] https://governance.openstack.org/tc/goals/selected/ussuri/project-ptl-and-contrib-docs.html
Story: #2007236
Task: #38554

Change-Id: Iaec58e0b4d4356144efd626a55c2cb7913e08f3a
2020-04-22 14:08:14 +00:00
Ghanshyam Mann fcf791b38a [ussuri][goal] Drop python 2.7 support and testing
OpenStack is dropping the py2.7 support in ussuri cycle.

os-testr is ready with python 3 and ok to drop the
python 2.7 support.

Complete discussion & schedule can be found in
- http://lists.openstack.org/pipermail/openstack-discuss/2019-October/010142.html
- https://etherpad.openstack.org/p/drop-python2-support

Ussuri Communtiy-wide goal:
https://governance.openstack.org/tc/goals/selected/ussuri/drop-py27.html

Switch to using sphinx-build, remove cruft from setup.cfg, setup.py,
tox.ini, conf.py.
Update hacking version to support python3 properly.
Fix problems found by pep8.

Change-Id: I6ab22dda05132a735bd9e5caf16cc2bd172b06cc
2020-03-04 01:35:46 +00:00
caoyuan ad00e6d41b Replace git.openstack.org URLs with opendev.org URLs
1. Replace git.openstack.org URLs with opendev.org URLs
2. Update some URLs to latest

Change-Id: Ifcb01ece24fb28d4dc28daa0a638787280fe8eb5
Closes-Bug: #1826529
2019-06-25 09:33:30 +00:00
Masayuki Igawa a5bc990fdc
Deprecate ostestr command
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
2019-06-03 18:44:07 +09:00
Zuul 7a8fa94fcd Merge "Trivial: Update pypi url to new url" 2018-12-16 11:16:24 +00:00
melissaml ca7669b283 Trivial: Update pypi url to new url
Pypi url changed from [1] to [2]

[1] https://pypi.python.org/pypi/<package>
[2] https://pypi.org/project/<package>

Change-Id: I493d691b5439b99eb77ae7ac7f36e0cdada92d2c
2018-04-21 12:33:58 +08:00
Masayuki Igawa 88bdf7d690
Remove useless links and indentations
This commit removes useless indices links on the top page and
indentations.

Change-Id: I32f89d298d579db5210217c9b8e3bc431c6567fd
2017-12-01 17:09:58 +09:00
Jenkins d67e6a1ff5 Merge "rearrange content to fit the new standard layout" 2017-07-11 21:41:20 +00:00
Dong Ma 4c04fbb5df Switch from oslosphinx to openstackdocstheme
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
2017-06-29 17:24:44 +08:00
Dong Ma b8377259c5 rearrange content to fit the new standard layout
Change-Id: Ia24cdc07e81814329108ea841231d8a721726b7e
Depends-On: Ia750cb049c0f53a234ea70ce1f2bbbb7a2aa9454
2017-06-29 00:07:49 +08:00
Masayuki Igawa ac8fb7ca90 Fix typo and change regexp to regex
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
2016-12-02 17:18:08 +09:00
Attila Fazekas 359224b4b0 Use dash instead of underscore in args
--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
2016-09-21 11:57:12 +00:00
Attila Fazekas 113e038869 Add --black-regex/-B option
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
2016-09-21 11:57:52 +02:00
Masayuki Igawa 2b33cfa983 Fix doc warnings and disable smarty-pants
This commit fixes some doc warnings and disables the smarty-pants
function. The html_use_smartypants function renders '--' to '–'(&#8211;)
but it's not good for command options.

Change-Id: Iab0a93db86f46f26b074ca3e9904fd5ff1b0f533
2016-06-29 13:57:02 +09:00
Matthew Treinish 89594a37e6 Remove the TODO file
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
2016-06-21 19:23:47 +00:00
Jenkins 79fa9a47fc Merge "Add documentation for generate-subunit" 2016-06-21 18:21:15 +00:00
Matthew Treinish 01da1dbac1
Add documentation for generate-subunit
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
2016-06-10 14:00:47 -04:00
Jenkins e5e11dca2e Merge "Add whitelist file to ostestr docs" 2016-05-26 02:00:46 +00:00
Matthew Treinish 74999a5dcc
Add whitelist file to ostestr docs
This commit adds the missing details for the whitelist file to the
ostestr docs.

Change-Id: I863dcad9b1a77a083f7007ab76760e77295c610d
2016-05-24 15:58:41 -04:00
Masayuki Igawa deaabb5fb7 Fix docs typos
This commit fixes docs typos.

Change-Id: I7f2369e2aad82f2883e408f56204c89e723cc376
2016-04-18 16:21:30 +09:00
Jake Yip 7980dde165 correct typo
Change-Id: I39e4eacadca8caa5c249de5a2105b4674a54a27b
2016-02-02 15:59:27 +11:00
Jenkins 2366c8c170 Merge "Add subunit_trace --color option's doc" 2016-01-07 01:20:33 +00:00
Masayuki Igawa 67079cd97e Add subunit_trace --color option's doc
This commit adds a document for the subunit_trace --color option.

Change-Id: I0278a20ead837d20161e4410abec0c711cc402cd
2015-12-05 23:04:49 +09:00
Masayuki Igawa 33119634b5 Fix documentation typos
This commit fixes some typos in the documentation.

Change-Id: I34ef7f863763bed2fb30421627968607bd787500
2015-12-05 22:55:06 +09:00
Matthew Treinish a8ca37c523
Switch to using autogenerated ChangeLog in docs
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
2015-09-24 11:52:20 -04:00
Matthew Treinish 2f29ca51be
Improved docs for os-testr commands
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
2015-07-17 11:09:23 -04:00
Matthew Treinish 131b5353a7 Add TODO file to os-testr
This commit adds a TODO file to the project to indicate both short and
long term work items for the project.

Change-Id: I90c19330eb5d8216a88f40411ed883e6f64c750d
2015-04-06 15:21:20 -04:00
Matthew Treinish d1049b1ad6 Initial Cookiecutter Commit. 2015-03-17 14:58:46 -04:00