Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/zenvin-dev/documentationgenerator-public
A repository to host builds of my Documentation Generator tool, for anyone to use.
https://github.com/zenvin-dev/documentationgenerator-public
automation documentation-generator generator net-core
Last synced: 4 days ago
JSON representation
A repository to host builds of my Documentation Generator tool, for anyone to use.
- Host: GitHub
- URL: https://github.com/zenvin-dev/documentationgenerator-public
- Owner: zenvin-dev
- License: apache-2.0
- Created: 2022-12-24T23:09:44.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2023-01-08T14:56:02.000Z (almost 2 years ago)
- Last Synced: 2024-06-16T18:58:02.024Z (5 months ago)
- Topics: automation, documentation-generator, generator, net-core
- Homepage:
- Size: 14.6 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# DocumentationGenerator-public
A repository to host builds of my Documentation Generator tool, for everyone to use.
---
Documentation and usage instructions can be found in this repository's Wiki.
---
# Quick Start: Using the CLI
The CLI is the main way of interfacing with the DocGen, until the UI is in a working state. \
It can work completely off of command line arguments and thus is perfectly suited to be invoked by shell scripts automating CI. \
If no arguments are given, execution will be interactive and prompts will appear for filling in relevant parameters.
## `documentation`
The `documentation` command tells the executable to generate documentation files, based on the given parameters.
### Synopsis
```
documentation
[-s|-settings ]
[-o|-output ]
[-version ]
[-p|-pause ]
[-l ]
```
### Options
- `-s|-settings` (required) \
The path given for this option must be a local file path pointing to a text file in JSON format.
The file must contain a valid configuration for the documentation generator.
- `-o|-output` \
If given a value, this will override the `Output:BaseDirectory` specified in the [Generation Settings](https://github.com/xZenvin/DocumentationGenerator-public/wiki/GenerationSettings#outputsettings).
- `-version` \
If given a value, this will overwrite the `Input.Version` specified in the generation settings.
- `-p|-pause` \
If set to `true`, the console will wait for user input after the process has finished or failed.
This defaults to `false` and is mainly meant for debugging purposes.
- `-l` \
If given a value, this will override the `Input:LinkRepository` specified in the [Generation Settings](https://github.com/xZenvin/DocumentationGenerator-public/wiki/GenerationSettings#inputsettings). \
*(Release `pre-0.0.2+`)*
## `links`
The `links` command allows creating a link repository file that can be used in future generation processes to eliminate the need for link prompts.
### Synopsis
```
links
[-s|-settings ]
[-o|-output ]
[-v|-validate ]
[-p|-pause ]
```
### Options
- `-s|-settings` (required)\
The path given for this option must be a local file path pointing to a text file in JSON format.
The file must contain a valid configuration for the documentation generator.
- `-o|-output` (required)\
The path of the output link repository file. This must be a valid file path.
The file extension will automatically be changed to `.zdlr`.
- `-v|-validate` \
If set to `true`, given links will be validated via web request, and a verification prompt will be given if the request returned an error. \
This defaults to `false`.
- `-p|-pause` \
If set to `true`, the console will wait for user input after the process has finished or failed.
This defaults to `false` and is mainly meant for debugging purposes.
## Exit Codes
Below is a table of exit codes that the CLI may return after finishing or failing, and their respective meanings.
| Code | Reason |
|-----:|:-------|
|0 | The process finished without errors. |
|-1 | The process failed due to an internal error of the generator. |
|-2 | The process name given was invalid. |
|-3 | The number of arguments given was invalid. |
|-4 | The Settings file provided via the `-s\|-settings` option did not exist or could not be parsed. |
|-5 | The output path was invalid so that the generation result could not be written. |