search

click-contrib / sphinx-click

A Sphinx plugin to automatically document click-based applications
MIT License
212 stars 57 forks source link

Add unique identifier for documented environment variables and remove… #27

Closed adamtheturtle closed 6 years ago

adamtheturtle commented 6 years ago

… them from the index.

Fixes #26 .

stephenfin commented 6 years ago

You need to fix the style checks here. I'm not sure about removing these from the index though. Shouldn't it be possible to count the environment variables we have found and simply include a reference to an existing one if they're duplicated?

adamtheturtle commented 6 years ago

The style issues appear unrelated.

mimischi commented 6 years ago

Any news on this PR? Just realized we are also experiencing this issue.

stephenfin commented 6 years ago

The style issues appear unrelated.

@adamtheturtle Indeed. Have rebased and just waiting on CI results before merging. Thanks!

(I missed the notification about your reply)

codecov-io commented 6 years ago

Codecov Report

Merging #27 into master will increase coverage by 0.43%. The diff coverage is 100%.

Impacted file tree graph

@@            Coverage Diff            @@
##           master     #27      +/-   ##
=========================================
+ Coverage   71.87%   72.3%   +0.43%     
=========================================
  Files           1       1              
  Lines         192     195       +3     
  Branches       51      51              
=========================================
+ Hits          138     141       +3     
  Misses         46      46              
  Partials        8       8
Impacted Files Coverage Δ
sphinx_click/ext.py 72.3% <100%> (+0.43%) :arrow_up:

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 f4923d2...12ee6db. Read the comment docs.