Skip to content

Commit

Permalink
Create Doxygen documentation (#1650)
Browse files Browse the repository at this point in the history
* clean branch

* update .yml

* update deploy branch

* ooooooook

* set develop as gh-pages deployer

* move Doxyfile

* just for test

* checks: ok

* update README.md

* try clone instead of submodule
  • Loading branch information
a-zakir authored Oct 5, 2023
1 parent 3033c34 commit cf4a792
Show file tree
Hide file tree
Showing 3 changed files with 2,908 additions and 0 deletions.
44 changes: 44 additions & 0 deletions .github/workflows/doxygen.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
name: GitHub Pages

on:
push:
branches:
- develop # Set a branch name to trigger deployment
pull_request:

jobs:
deploy:
runs-on: ubuntu-22.04
permissions:
contents: write
concurrency:
group: ${{ github.workflow }}-${{ github.ref }}
steps:
- uses: actions/checkout@v3
with:
submodules: true # Fetch Hugo themes (true OR recursive)
fetch-depth: 0 # Fetch all history for .GitInfo and .Lastmod

- name: theme
run: |
git clone https://github.com/jothepro/doxygen-awesome-css.git
cd doxygen-awesome-css
git checkout v2.2.1
- name: Doxygen
uses: mattnotmitt/[email protected]
with:
doxyfile-path: docs/Doxyfile

- name: Deploy
uses: peaceiris/actions-gh-pages@v3
# If you're changing the branch from main,
# also change the `main` in `refs/heads/main`
# below accordingly.
if: github.ref == 'refs/heads/develop'
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./html



1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,7 @@ In May 2018 RTE decided to release the project under the GPLv3 license.

- Antares web site : https://antares-simulator.org
- RTE web site : http://www.rte-france.com/
- Doxygen code documentation : https://antaressimulatorteam.github.io/Antares_Simulator/


# Installation
Expand Down
Loading

0 comments on commit cf4a792

Please sign in to comment.