https://github.com/courseorchestra/celestadoc

https://github.com/courseorchestra/celestadoc

Last synced: 12 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/courseorchestra/celestadoc
• Owner: CourseOrchestra
• License: gpl-3.0
• Created: 2018-10-01T18:09:56.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2023-02-28T01:03:48.000Z (almost 3 years ago)
• Last Synced: 2025-01-21T21:15:35.029Z (about 1 year ago)
• Language: Java
• Size: 73.2 KB
• Stars: 0
• Watchers: 2
• Forks: 1
• Open Issues: 9
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# CelestaDoc

[![Actions Status: build](https://github.com/courseorchestra/celestadoc/workflows/build/badge.svg)](https://github.com/courseorchestra/celestadoc/actions?query=workflow%3A"build")

[![Maven Central](https://maven-badges.herokuapp.com/maven-central/ru.curs/celestadoc/badge.svg)](https://maven-badges.herokuapp.com/maven-central/ru.curs/celestadoc)

Generates celesta documentation report.

First, you should install project:

```shell

mvn clean install

```

After you can get zip-archive CelestaDoc, inside it you can find celestadoc.bat file.

Run it with the next command:

```shell

celestadoc.bat    [optional]-pdf [optional]-html [optional][-plantuml [optional]]

```

where 

* `path_to_directory_with_celesta_sql` - directory with celesta sql,

* `prefix` - some prefix which is used in celesta docs (For example, `doc-ru`)

* `output_file.adoc` - path to file which will be created. It should be .adoc file

* `-pdf` - optional flag for generating pdf file from adoc file. This file will be

created in the same directory as .adoc report, and it will had the same name `output_file.pdf`

* `-html` - optional flag for generating html file from adoc file. This file will be created in the same directory

as .adoc report, and it will had the same name `output_file.html`

* `-plantuml` - optional flag for generating plant UML file from celesta sql file. This file will be created in the same

directory as .adoc report, and it will had the same name `output_file.pu`

* `param_file.pu` - file with params for plant UML's diagram. It must be used only with flag `-plantuml`, and must be

after this flag. This param is optional parameter. For example, you can write `-plantuml my_param.pu` or `-plantuml`.

In second case in section `!include` will be included default file `pu_params.pu`, that can be found in project's sources.