search

puppetlabs / puppet-editor-services

Puppet Language Server for editors
Apache License 2.0
45 stars 21 forks source link

Generate documentation using Puppet Strings #249

Open jpogran opened 4 years ago

jpogran commented 4 years ago

Generate documentation using Puppet Strings

  1. A standalone command (e.g. Puppet : Generate Module Documentation)

  2. Possibly a standalone command to generate documentation for the currently edited file (e.g. Puppet : Preview documentation for this file), which would create a virtual, Read Only markdown document. Similar to the current Preview Markdown command.

  3. An optional client side event watcher for File -> Save. And then depending on the file, automatically generate the module documentation. This would be behind a setting as you probable wouldn't want this on by default.

Also it should only be active if you're in a module.

Originally posted by @glennsarti in https://github.com/puppetlabs/puppet-vscode/issues/153#issuecomment-549338625

jpogran commented 4 years ago

Created new issue in editor-services instead of moving original issue because it will require implementation in both places

glennsarti commented 4 years ago

This is a 1.0 feature (1.0 heavily depends of Puppet Strings.)