aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorGheorghe Popescu <gheorghe.popescu@puppet.com>2020-05-06 15:51:36 +0300
committerGitHub <noreply@github.com>2020-05-06 15:51:36 +0300
commitcebfbf3365b08e967366c8e1b26e0297d17268d3 (patch)
treee524cb38aa1396445e74cef0cc3d436c7d927904 /README.md
parent273991657d2fea239ef7b6be5a40a728ad507772 (diff)
parent75ed14ce76a643f8e41ce06d519dfe9d1017b86e (diff)
downloadpuppet-cron_core-cebfbf3365b08e967366c8e1b26e0297d17268d3.tar.gz
puppet-cron_core-cebfbf3365b08e967366c8e1b26e0297d17268d3.tar.bz2
Merge pull request #32 from GabrielNagy/1.0.4_release
Diffstat (limited to 'README.md')
-rw-r--r--README.md2
1 files changed, 1 insertions, 1 deletions
diff --git a/README.md b/README.md
index 7aed631..3460895 100644
--- a/README.md
+++ b/README.md
@@ -26,7 +26,7 @@ To generate documentation locally, run the following command:
```
bundle install
-bundle exec puppet strings generate ./lib/**/*.rb
+bundle exec puppet strings generate --format markdown --out REFERENCE.md
```
This command will create a browsable \_index.html file in the doc directory. The references available here are all generated from YARD-style comments embedded in the code base. When any development happens on this module, the impacted documentation should also be updated.