Doc-N-Save
Table of Contents
NAME
Doc-N-Save
AUTHOR
Francis Grizzly Smit (grizzly@smit.id.au)
VERSION
0.1.30
TITLE
Doc-N-Save
SUBTITLE
A collection of Raku programs for managing modules and apps in Raku, and do things like summit to zef etc.
COPYRIGHT
GPL V3.0+ LICENSE
Top of Document
Introduction
A collection of Raku programs for managing modules and apps in Raku, and do things like summit to zef etc.
doc-n-save a program for generating Documentation from pod files (files containing pod6 markup) and saving the result to git.
mk-raku-dirs either create a full skeleton repository from a few simple arguments or make sure that an existing repository is complete.
release is a program to send a new release to zef via fez.
release-d is a program to send a new release to zef via fez this one solves a bug in fez.
doc-n-save.raku
doc-n-save
doc-n-save --help
Usage:
doc-n-save [-c|--comment=<Str>]
doc-n-save create config <name> [<additional-pod-files> ...] [-l|--lib=<Str>] [-b|--bin=<Str>] [-e|--exts=<Str>] [-d|--docs=<Str>] [-m|--markdown-path=<Str>] [-o|--only-app] [--separate-markdown-files] [-c|--comment=<Str>]
doc-n-save prompt create config [<name>] [<additional-pod-files> ...] [-l|--lib=<Str>] [-b|--bin=<Str>] [-e|--exts=<Str>] [-d|--docs=<Str>] [-m|--markdown-path=<Str>] [-o|--only-app] [--separate-markdown-files] [-c|--comment=<Str>]
doc-n-save explicit <name> [<additional-pod-files> ...] [-l|--lib=<Str>] [-b|--bin=<Str>] [-e|--exts=<Str>] [-d|--docs=<Str>] [-m|--markdown-path=<Str>] [-o|--only-app] [--separate-markdown-files] [-c|--comment=<Str>]
doc-n-save expects to be run from the root directory of the project.
Where (in brief)
The first form doc-n-save [-c|--comment=<Str>] expects a .doc-n-save.json file to exist in the root directory of the project which is where you run doc-n-save from.
- comment should be a string to override the comment in the
.doc-n-save.json file or leave it out to leave that comment in.
the doc-n-save create config creates a .doc-n-save.json file for the first form to use.
doc-n-save prompt create config also creates a config file .doc-n-save.json but gives you a input-menu that allows you to build the correct values a step at a time.
The doc-n-save explicit form takes all the same arguments as the doc-n-save create config form but does the create docs and save them to git without saving the args like the other.
Top of Document
doc-n-save
With no arguments doc-n-save looks for a file called .doc-n-save.json and uses that to set the parameters to generate the docs and then save them to git i.e. commit and push to main/remote repo.
doc-n-save --help
Usage:
doc-n-save [-c|--comment=<Str>]
Top of Document
doc-n-save create config
Generates the .doc-n-save.json from the supplied arguments and any Environment.
doc-n-save --help
Usage:
doc-n-save create config <name> [<additional-pod-files> ...] [-l|--lib=<Str>] [-b|--bin=<Str>] [-e|--exts=<Str>] [-d|--docs=<Str>] [-m|--markdown-path=<Str>] [-o|--only-app] [--separate-markdown-files] [-c|--comment=<Str>]
Where
name is the name of the primary pod file
- NB: can be an application file (i.e. ending in .raku), a Module (i.e. ending in .rakumod) or a doc file (i.e. ending in .rakudoc).
additional-pod-files... A list of zero or more other pod files.
-l|--lib= The name of the library directory by default rakulib with a symbolic link of lib to alias it to that.
-b|--bin= The name of the bin directory, for executables within the library.
-e|--exts= An array of extensions to look for separated by : by default rakumod:raku:rakudoc these are the standard extensions so you probably should leave this alone.
-d|--docs= The name of the documentation directory.
-m|--markdown-path= The path to the primary markdown file by default README.md, generally leave this alone.
-o|--only-app Set to true if this is a executable only package (i.e. no modules).
--separate-markdown-files Set to true if you want each markdown file to generate it's own markdown file, generally you don't want this, as raku.land currently will not carry the docs directory etc.
-c|--comment= Set to a comment you want to use for the git commit defaults to using doc-n-save.
Top of Document
doc-n-save prompt create config
Build the .doc-n-save.json file interactively using a menu system.
doc-n-save prompt create config --help
Usage:
doc-n-save prompt create config [<name>] [<additional-pod-files> ...] [-l|--lib=<Str>] [-b|--bin=<Str>] [-e|--exts=<Str>] [-d|--docs=<Str>] [-m|--markdown-path=<Str>] [-o|--only-app] [--separate-markdown-files] [-c|--comment=<Str>]
Where
name is the name of the primary pod file
- NB: can be an application file (i.e. ending in .raku), a Module (i.e. ending in .rakumod) or a doc file (i.e. ending in .rakudoc).
additional-pod-files... A list of zero or more other pod files.
-l|--lib= The name of the library directory by default rakulib with a symbolic link of lib to alias it to that.
-b|--bin= The name of the bin directory, for executables within the library.
-e|--exts= An array of extensions to look for separated by : by default rakumod:raku:rakudoc these are the standard extensions so you probably should leave this alone.
-d|--docs= The name of the documentation directory.
-m|--markdown-path= The path to the primary markdown file by default README.md, generally leave this alone.
-o|--only-app Set to true if this is a executable only package (i.e. no modules).
--separate-markdown-files Set to true if you want each markdown file to generate it's own markdown file, generally you don't want this, as raku.land currently will not carry the docs directory etc.
-c|--comment= Set to a comment you want to use for the git commit defaults to using doc-n-save.
Top of Document
doc-n-save prompt create config doc-n-save mk-raku-dirs release release-d
Configure Doc-N-Save
0 name > doc-n-save
1 lib > rakulib
2 bin > bin
3 exts > rakumod, raku, rakudoc
4 docs > docs
5 markdown-path > README.md
6 only-app > False
7 separate-markdown-files > False
8 comment > using doc-n-save
9 additional-pod-files > mk-raku-dirs, release, release-d
10 cancel > cancel
11 OK > OK
use cancel, bye, bye bye, quit, q, or 11 to quit or enter to accept the values as is
choose a candidate 0..11 =:> ⌼
Top of Document
doc-n-save explicit
Define the docs etc explicitly and then commit to git etc.
doc-n-save explicit --help
Usage:
doc-n-save explicit <name> [<additional-pod-files> ...] [-l|--lib=<Str>] [-b|--bin=<Str>] [-e|--exts=<Str>] [-d|--docs=<Str>] [-m|--markdown-path=<Str>] [-o|--only-app] [--separate-markdown-files] [-c|--comment=<Str>]
Where
name is the name of the primary pod file
- NB: can be an application file (i.e. ending in .raku), a Module (i.e. ending in .rakumod) or a doc file (i.e. ending in .rakudoc).
additional-pod-files... A list of zero or more other pod files.
-l|--lib= The name of the library directory by default rakulib with a symbolic link of lib to alias it to that.
-b|--bin= The name of the bin directory, for executables within the library.
-e|--exts= An array of extensions to look for separated by : by default rakumod:raku:rakudoc these are the standard extensions so you probably should leave this alone.
-d|--docs= The name of the documentation directory.
-m|--markdown-path= The path to the primary markdown file by default README.md, generally leave this alone.
-o|--only-app Set to true if this is a executable only package (i.e. no modules).
--separate-markdown-files Set to true if you want each markdown file to generate it's own markdown file, generally you don't want this, as raku.land currently will not carry the docs directory etc.
-c|--comment= Set to a comment you want to use for the git commit defaults to using doc-n-save.
Top of Document