Skip to content

Conversation

@lennertvandevelde
Copy link
Collaborator

Split up Argument types between Positional, Required and Optional.

Example Output:

shacl2md

Usage:

usage: shacl2md [-h] --language [language [language ...]] [--out out] [--parent parent] [--layout layout] [--nav_order nav_order] [--name name] [--crosslinks [crosslinks [crosslinks ...]]] [--vdir]
               [--validate] [--nodocs]
               inputFile [inputFile ...]

Positional Arguments

Option Default Description
files None SHACL OR RDFS files to construct Markdown documentation of.

Required Arguments

Option Default Description
--language ['nl'] languages of generated documentation, default is "nl"

Optional Arguments

Option Default Description
-h, --help show this help message and exit
--out ./ output directory for files, default is "./"
--parent index Jekyll parent page, default is "index"
--layout default Jekyll layout, default is "default"
--nav_order 1 Jekyll nav order, default is 1
--name output filename for the output file, default is "output"
--crosslinks None crosslink graphs to find classes in: format is "name;file1;file2;..."
--vdir if present, outputs files to a directory based on the SHACL version
--validate if present, the shacl file is validated against the SHACL-SHACL.
--nodocs if present, only a diagram is produced.

@devanshkv devanshkv self-requested a review December 29, 2022 21:30
@devanshkv devanshkv self-assigned this Dec 29, 2022
@devanshkv devanshkv added the enhancement New feature or request label Dec 29, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants