openstack/deb-python-os-testr
Code Issues Proposed changes

Fix doc warnings and disable smarty-pants

Browse Source 
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
This commit is contained in:
Masayuki Igawa 2016-06-29 13:57:02 +09:00
parent 023351aef2
commit 2b33cfa983
2 changed files with 7 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
doc/source/conf.py
View File

@ -58,6 +58,10 @@ pygments_style = 'sphinx'
# html_theme = '_theme'
# html_static_path = ['static']
# If true, SmartyPants will be used to convert quotes and dashes to
# typographically correct entities.
html_use_smartypants = False
# Output file base name for HTML help builder.
htmlhelp_basename = '%sdoc' % project

5
doc/source/ostestr.rst
View File

@ -217,13 +217,14 @@ Notes for running with tox
--------------------------
If you use `tox`_ for running your tests and call ostestr as the test command
.. _tox: https://tox.readthedocs.org/en/latest/
it's recommended that you set a posargs following ostestr on the commands
stanza. For example::
stanza. For example::
[testenv]
commands = ostestr {posargs}
.. _tox: https://tox.readthedocs.org/en/latest/
this will enable end users to pass args to configure the output, use the
selection logic, or any other options directly from the tox cli. This will let
tox take care of the venv management and the environment separation but enable