Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

new shield_list customization option #99

Closed
wants to merge 4 commits into from
Closed

new shield_list customization option #99

wants to merge 4 commits into from

Conversation

buhman
Copy link

@buhman buhman commented Mar 10, 2017

I originally just wanted support for a circleci button, then I realized this could be made much more generic.

This adds support for including arbitrary shields in the about section.

Usage:

html_theme_options = {
    'shield_list': [
        {
            'image': 'https://img.shields.io/circleci/project/github/RedSparr0w/node-csgo-parser.svg',
            'target': 'https://circleci.com/gh/RedSparr0w/node-csgo-parser'
        }
    ]
}

Copy link

@polyzen polyzen left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me.

@bitprophet
Copy link
Collaborator

Nice, thanks! Related / possibly subsumed in this: #13, #52.

Minor nitpicks:

  • we don't use circleci ourselves last I checked, so using it in the example snippet feels funny - I'd switch it to reference codecov or travis or something maybe?
  • which brings one to: this should arguably replace/deprecate the standalone options for travis and codecov. Can't actually replace til a later release, but we should least list this above those two, and add note/warn blocks to those two saying "you should probably use shield_list instead".

Also wondered if we could roll the GH button into this too, but it seems to use different HTML so meh, no big deal. (GH also has other options as well, so, it's special.)

@buhman
Copy link
Author

buhman commented Mar 11, 2017

this should arguably replace/deprecate the standalone options for travis and codecov

I agree.

we don't use circleci ourselves last I checked

Yep; I didn't want to passive-aggressively suggest that shield_list should replace travis_button without actually establishing that first.

@buhman
Copy link
Author

buhman commented Mar 11, 2017

@bitprophet I changed the example to something that actually exists.

@bitprophet bitprophet added this to the 0.7.11 milestone Mar 11, 2017
@bitprophet bitprophet modified the milestones: 0.7.11, 0.7.12 Sep 6, 2018
@sloria
Copy link
Contributor

sloria commented Sep 6, 2018

This is almost identical to #124 . The only difference is that #124 uses a different option name (badges) and allows width, height, and alt. It doesn't have the docs re: deprecation, though. FWIW, I think badges is a better name name than shield_list because it is more service-agnostic and therefore more future-proof (could easily switch to badgen and the option name would still make sense).

@bitprophet I recommend going with either this or #124 and closing the other.

@buhman buhman closed this Sep 8, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants