diff --git a/.github/workflows/CI.yml b/.github/workflows/CI.yml index cb5e4d9..eabf7c7 100644 --- a/.github/workflows/CI.yml +++ b/.github/workflows/CI.yml @@ -68,10 +68,10 @@ jobs: env: GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} DOCUMENTER_KEY: ${{ secrets.DOCUMENTER_KEY }} - - name: Run doctests - shell: julia --project=docs --color=yes {0} - run: | - using Documenter: DocMeta, doctest - using IESopt - DocMeta.setdocmeta!(IESopt, :DocTestSetup, :(using IESopt); recursive=true) - doctest(IESopt) + # - name: Run doctests + # shell: julia --project=docs --color=yes {0} + # run: | + # using Documenter: DocMeta, doctest + # using IESopt + # DocMeta.setdocmeta!(IESopt, :DocTestSetup, :(using IESopt); recursive=true) + # doctest(IESopt) diff --git a/LICENSE b/LICENSE index 725814a..30fd923 100644 --- a/LICENSE +++ b/LICENSE @@ -1,6 +1,6 @@ MIT License -Copyright (c) 2024 Stefan Strömer and contributors +Copyright (c) AIT Austrian Institute of Technology GmbH Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/README.md b/README.md index b04cc41..6611deb 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,51 @@ -# IESopt +# Integrated Energy System Optimization (IESopt.jl) [![Stable](https://img.shields.io/badge/docs-stable-blue.svg)](https://ait-energy.github.io/IESopt.jl/stable/) [![Dev](https://img.shields.io/badge/docs-dev-blue.svg)](https://ait-energy.github.io/IESopt.jl/dev/) [![Build Status](https://github.com/ait-energy/IESopt.jl/actions/workflows/CI.yml/badge.svg?branch=main)](https://github.com/ait-energy/IESopt.jl/actions/workflows/CI.yml?query=branch%3Amain) [![Coverage](https://codecov.io/gh/ait-energy/IESopt.jl/branch/main/graph/badge.svg)](https://codecov.io/gh/ait-energy/IESopt.jl) [![Aqua](https://raw.githubusercontent.com/JuliaTesting/Aqua.jl/master/badge.svg)](https://github.com/JuliaTesting/Aqua.jl) + +[![Code Style](https://img.shields.io/badge/code_style-custom-blue?style=flat&logo=julia&logoColor=white)](.JuliaFormatter.toml) +[![Readme Style](https://img.shields.io/badge/readme_style-standard-lime?style=flat&logo=julia&logoColor=white)](https://github.com/RichardLitt/standard-readme) +[![License](https://img.shields.io/github/license/ait-energy/IESopt.jl)](LICENSE) + +**IESopt** (_Integrated Energy System Optimization_) is a modeling and optimization framework for integrated energy +systems. + +## Table of Contents + +- [Background](#background) +- [Install](#install) +- [Usage](#usage) +- [API](#api) +- [Contributing](#contributing) +- [License](#license) + +## Background + +TODO + +## Install + +TODO: Documment how to install the package. + +## Usage + +TODO: Documment how to use the package. + +## API + +TODO: Documment the API of the package. + +### Python + +### Julia + +## Contributing + +PRs accepted. + +## License + +[MIT © AIT Austrian Institute of Technology GmbH.](LICENSE) diff --git a/docs/make.jl b/docs/make.jl index ff7f63e..ffc2c45 100644 --- a/docs/make.jl +++ b/docs/make.jl @@ -1,11 +1,11 @@ using IESopt using Documenter -DocMeta.setdocmeta!(IESopt, :DocTestSetup, :(using IESopt); recursive=true) +# DocMeta.setdocmeta!(IESopt, :DocTestSetup, :(using IESopt); recursive=true) makedocs(; modules=[IESopt], - authors="Stefan Strömer and contributors", + authors="Stefan Strömer (@sstroemer), Daniel Schwabeneder (@daschw), and contributors", sitename="IESopt.jl", format=Documenter.HTML(; canonical="https://ait-energy.github.io/IESopt.jl",