dgeni-alive icon indicating copy to clipboard operation
dgeni-alive copied to clipboard

A way to omit the Installation documentation from a module

Open VanTanev opened this issue 8 years ago • 1 comments

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

VanTanev avatar Jun 11 '16 18:06 VanTanev

The easiest way to achieve this is

  • add new template folder
  • copy module.template.html to new folder
  • remove content from {% block installation %}

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

wingedfox avatar Aug 18 '16 17:08 wingedfox