search

markvincze / sabledocs

Simple static documentation generator for Protobuf and gRPC contracts.
MIT License
46 stars 12 forks source link

Hide packages on index #12

Closed hedtke closed 9 months ago

hedtke commented 10 months ago

There is a new option hide-packages where one can give a list of packages that should not be shown. The SableContext has a new computed property non_hidden_packages which respects that. The old member packages still contains both.

In the templates index.html and package.html, non_hidden_packages can be used in addition to the old packages.

I updated the readme and the changelog (I plan some more features, that's why I did not specify a new version number yet, but I am also fine with publishing individual features in individual new versions)

markvincze commented 10 months ago

@hedtke Looks good, thanks for the submission!

One small thing: I think maybe the name hidden-packages would be better in the config? That way it's consistent with non_hidden_packages. And hide-packages sounds like as if it was a boolean, and not a list of items.

Merging to main will kick off the release process anyway, so feel free to bump the version number, and adjust it in the changelog too, then it'll be released with the correct version once I merge.

hedtke commented 9 months ago

@markvincze Parameter renamed and version in changelog bumped