From 2b33cfa983413294cc9765129953b2d9eda856de Mon Sep 17 00:00:00 2001 From: Masayuki Igawa Date: Wed, 29 Jun 2016 13:57:02 +0900 Subject: [PATCH] Fix doc warnings and disable smarty-pants MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 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 --- doc/source/conf.py | 4 ++++ doc/source/ostestr.rst | 5 +++-- 2 files changed, 7 insertions(+), 2 deletions(-) diff --git a/doc/source/conf.py b/doc/source/conf.py index 45a8546..17a0271 100755 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -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 diff --git a/doc/source/ostestr.rst b/doc/source/ostestr.rst index b179074..7d8b1cf 100644 --- a/doc/source/ostestr.rst +++ b/doc/source/ostestr.rst @@ -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