wingedfox / dgeni-alive

Live docs on top of dgeni documentation generator
MIT License
26 stars 14 forks source link

A way to omit the Installation documentation from a module #7

Open VanTanev opened 8 years ago

VanTanev commented 8 years ago

Currently, there seems to be no way to omit or change the installation documentation for a module. When using dgeni-alive for a private project documentation, and there are multiple sub-modules, this is just distracting.

Maybe just adding a check similar to this in the installation template would be enough: https://github.com/angular/angular.js/blob/3bcbd63e47b7a7210ca8cf0ad75d14605018c91e/docs/config/templates/api/module.template.html#L9-L11 (or, maybe the check should be: If @installation is present, use that, otherwise check for @packageName and use the current version, or dispaly nothing

wingedfox commented 8 years ago

The easiest way to achieve this is

If you'd like to add installation suppression tag PR is welcome.