Skip to content

Commit 27ce972

Browse files
committed
Parser: Drop epilog message for Sphinx help
When calling `tox.config.cli.parse._get_parser_doc()` from the Sphinx documentation build, reset the `.epilog` property on the returned parser object. This ensures the help will be formatted without any messages about configuration files. Fixes #3585 Signed-off-by: FeRD (Frank Dana) <[email protected]>
1 parent be1a50a commit 27ce972

File tree

1 file changed

+4
-1
lines changed

1 file changed

+4
-1
lines changed

src/tox/config/cli/parse.py

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,10 @@ def _get_parser_doc() -> ToxParser:
9191

9292
MANAGER.load_plugins(Path.cwd())
9393

94-
return _get_parser() # pragma: no cover
94+
parser = _get_parser() # pragma: no cover
95+
# Remove epilog message from help when formatting website docs
96+
parser.epilog = None
97+
return parser
9598

9699

97100
__all__ = (

0 commit comments

Comments
 (0)