click-contrib / sphinx-click

A Sphinx plugin to automatically document click-based applications

MIT License

212 stars 57 forks source link

Do not show hidden sub-commands as valid command options #34

Closed james-ennis closed 5 years ago

james-ennis commented 5 years ago

This PR ensures that sub-commands which have been marked as 'hidden' (requires Click >= 7.0), are not shown as valid command options in the documentation generated for the higher level command.

Closes #33

codecov-io commented 5 years ago

Codecov Report

Merging #34 into master will decrease coverage by 0.07%. The diff coverage is 66.66%.

@@            Coverage Diff             @@
##           master      #34      +/-   ##
==========================================
- Coverage   72.05%   71.98%   -0.08%     
==========================================
  Files           1        1              
  Lines         204      207       +3     
  Branches       54       56       +2     
==========================================
+ Hits          147      149       +2     
  Misses         48       48              
- Partials        9       10       +1

Impacted Files	Coverage Δ
sphinx_click/ext.py	`71.98% <66.66%> (-0.08%)`	:arrow_down:

Continue to review full report at Codecov.

Legend - Click here to learn more Δ = absolute <relative> (impact), ø = not affected, ? = missing data Powered by Codecov. Last update b5e5f89...6ee6b28. Read the comment docs.

codecov-io commented 5 years ago

Codecov Report

Merging #34 into master will decrease coverage by 0.07%. The diff coverage is 66.66%.

@@            Coverage Diff             @@
##           master      #34      +/-   ##
==========================================
- Coverage   72.05%   71.98%   -0.08%     
==========================================
  Files           1        1              
  Lines         204      207       +3     
  Branches       54       56       +2     
==========================================
+ Hits          147      149       +2     
  Misses         48       48              
- Partials        9       10       +1

Impacted Files	Coverage Δ
sphinx_click/ext.py	`71.98% <66.66%> (-0.08%)`	:arrow_down:

Continue to review full report at Codecov.

Legend - Click here to learn more Δ = absolute <relative> (impact), ø = not affected, ? = missing data Powered by Codecov. Last update b5e5f89...6ee6b28. Read the comment docs.

stephenfin commented 5 years ago

Thanks very much for doing this, @james-ennis. I've just pushed the 2.0.1 tag so this should be out in the wild shortly.

james-ennis commented 5 years ago

@stephenfin you're welcome, thank you for the quick merge and release!