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

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

Open
VanTanev opened this issue Jun 11, 2016 · 1 comment
Open

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

VanTanev opened this issue Jun 11, 2016 · 1 comment

Comments

@VanTanev
Copy link
Contributor

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
Copy link
Owner

The easiest way to achieve this is

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants