Skip to content
Snippets Groups Projects
Commit ffafd0cc authored by Riccardo Boero's avatar Riccardo Boero :innocent:
Browse files

Added README and documentation src and CI/CD part.

parent 6e0fb296
No related branches found
No related tags found
No related merge requests found
image: julia:latest
stages:
- documentation
- deploy
build documentation:
stage: documentation
script:
- julia --project=. -e 'using Pkg; Pkg.instantiate()'
- julia --project=. docs/make.jl
artifacts:
paths:
- docs/build/
expire_in: 1 week
only:
- main
pages:
stage: deploy
script:
- mv docs/build public
artifacts:
paths:
- public
only:
- main
# FACT Workflow Manager
A Julia workflow manager, reading workflow from .toml files and running asynchronous parallel and sequential tasks based on FACT Data containers, saving results on FACT Results container.
---
## Use
Please refer to the APIs accessible in the documentation section: https://fact.pages.nilu.no/utils/FACTWorkflowManager
---
## Specifications
---
## Notes
---
### Authors
Riccardo Boero - ribo@nilu.no
### License
using Documenter
using FACTWorkflowManager
makedocs(
sitename = "FACT Workflow Manager",
modules = [FACTWorkflowManager],
format = Documenter.HTML(
repolink = "https://git.nilu.no/fact/utils/FACTWorkflowManager.git"
),
repo = "https://git.nilu.no/fact/utils/FACTWorkflowManager.git"
)
# API Reference
```@autodocs
Modules = [FACTWorkflowManager]
Private
Order = [:function, :type]
```
```@docs
FACTWorkflowManager.FACTWorkflowManager
```
\ No newline at end of file
# Documentation
Contents:
- [API Reference](api.md)
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment