Merge pull request #5 from click-contrib/click-sphinx-workaround

sphinx-click a temporary workaround

Author: espdev

CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## v0.3.1
+
+* Add `hidden=True` to `_GroupTitleFakeOption` as a temporary workaroud for issue [#4](https://github.com/click-contrib/click-option-group/issues/4)
+
 ## v0.3.0
 * Add support for hidden options inside groups (PR [#2](https://github.com/click-contrib/click-option-group/pull/2))
 

click_option_group/_core.py

@@ -68,7 +68,7 @@ class _GroupTitleFakeOption(click.Option):
 
     def __init__(self, param_decls=None, *, group: 'OptionGroup', **attrs):
         self.__group = group
-        super().__init__(param_decls, expose_value=False, **attrs)
+        super().__init__(param_decls, hidden=True, expose_value=False, help=group.help, **attrs)
 
     def get_help_record(self, ctx: click.Context):
         return self.__group.get_help_record(ctx)

click_option_group/_version.py

@@ -1,3 +1,3 @@
 # -*- coding: utf-8 -*-
 
-__version__ = '0.3.0'
+__version__ = '0.3.1'

tests/test_click_option_group.py

@@ -261,8 +261,8 @@ def cli(foo, bar):
     assert result.exception
     assert result.exit_code == 2
     assert 'Missing one of the required options' in result.output
-    assert '"--foo"' in result.output
-    assert '"--bar"' in result.output
+    assert '--foo' in result.output
+    assert '--bar' in result.output
 
     result = runner.invoke(cli, ['--foo', 'foo'])
     assert not result.exception
@@ -298,22 +298,22 @@ def cli(foo, bar):
     assert result.exception
     assert result.exit_code == 2
     assert 'Missing required options from' in result.output
-    assert '"--foo"' in result.output
-    assert '"--bar"' in result.output
+    assert '--foo' in result.output
+    assert '--bar' in result.output
 
     result = runner.invoke(cli, ['--foo', 'foo'])
     assert result.exception
     assert result.exit_code == 2
     assert 'Missing required options from' in result.output
-    assert '"--foo"' not in result.output
-    assert '"--bar"' in result.output
+    assert '--foo' not in result.output
+    assert '--bar' in result.output
 
     result = runner.invoke(cli, ['--bar', 'bar'])
     assert result.exception
     assert result.exit_code == 2
     assert 'Missing required options from' in result.output
-    assert '"--foo"' in result.output
-    assert '"--bar"' not in result.output
+    assert '--foo' in result.output
+    assert '--bar' not in result.output
 
     result = runner.invoke(cli, ['--foo', 'foo', '--bar', 'bar'])
     assert not result.exception
@@ -345,22 +345,22 @@ def cli(foo, bar, spam):
     assert result.exception
     assert result.exit_code == 2
     assert 'The given mutually exclusive options cannot be used at the same time' in result.output
-    assert '"--foo"' in result.output
-    assert '"--bar"' in result.output
+    assert '--foo' in result.output
+    assert '--bar' in result.output
 
     result = runner.invoke(cli, ['--foo', 'foo', '--spam', 'spam'])
     assert result.exception
     assert result.exit_code == 2
     assert 'The given mutually exclusive options cannot be used at the same time' in result.output
-    assert '"--foo"' in result.output
-    assert '"--spam"' in result.output
+    assert '--foo' in result.output
+    assert '--spam' in result.output
 
     result = runner.invoke(cli, ['--bar', 'bar', '--spam', 'spam'])
     assert result.exception
     assert result.exit_code == 2
     assert 'The given mutually exclusive options cannot be used at the same time' in result.output
-    assert '"--bar"' in result.output
-    assert '"--spam"' in result.output
+    assert '--bar' in result.output
+    assert '--spam' in result.output
 
     result = runner.invoke(cli, ['--foo', 'foo'])
     assert not result.exception
@@ -397,9 +397,9 @@ def cli(foo, bar, spam):
     assert result.exception
     assert result.exit_code == 2
     assert 'Missing one of the required mutually exclusive options' in result.output
-    assert '"--foo"' in result.output
-    assert '"--bar"' in result.output
-    assert '"--spam"' in result.output
+    assert '--foo' in result.output
+    assert '--bar' in result.output
+    assert '--spam' in result.output
 
 
 @pytest.mark.parametrize('cls', [

tox.ini

@@ -3,7 +3,7 @@ envlist = py{36,37,38}-pytest-coverage, flake8
 
 [testenv]
 deps = pytest
-commands = pytest --color=yes {posargs}
+commands = pytest --color=yes -v {posargs}
 
 [testenv:py37-pytest-coverage]
 usedevelop = true
@@ -14,7 +14,7 @@ deps =
     pytest-cov
     coveralls
 commands =
-    pytest --cov=click_option_group --color=yes {posargs}
+    pytest --cov=click_option_group --color=yes -v {posargs}
     coveralls
 
 [testenv:flake8]