Skip to content

Commit

Permalink
deploy doxygen code documentation (#711)
Browse files Browse the repository at this point in the history
* deploy doxygen code documentation

* add tests to doc page

* tmp deploy with this branch

* update project name

* update exclude dir

* disable jekyll

* exclude dirs

* try darkmode

* reset link

* fix link

* add doxygen link in README

* set develop as deployer

* set README.md as main page

* tmp

* add .md docs

* try latex

* update OG

* update doc

* remove unwanted character

* develop as the only deployer
  • Loading branch information
a-zakir authored Nov 15, 2023
1 parent debef8a commit b19cd1b
Show file tree
Hide file tree
Showing 6 changed files with 2,975 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

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
git apply ../docs/antares-xpansion.patch
- name: Doxygen
uses: mattnotmitt/doxygen-action@1.9.5
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



Empty file added .nojekyll
Empty file.
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,9 @@ The [Antares-Xpansion][xpansion-github] package, works along with RTE's adequacy

Please see the [Antares-Xpansion Documentation][readthedocs] for an introductory tutorial,
and a full user guide.

For developers: [here][xpansion-doxygen] you can find doxygen code documentation.

Check out the [Antares-Simulator documentation][readthedocs-antares] for more insights on Antares.

Antares-Xpansion optimizes the investments on new capacities and transmission lines for an Antares study. Typical uses of Antares-Xpansion are for example:
Expand Down Expand Up @@ -133,6 +136,7 @@ For build instructions, please visit the [developer guide][developer-guide].
[antares_xpansion_release_url]: https://github.com/AntaresSimulatorTeam/antares-xpansion/releases

[xpansion-github]: https://github.com/AntaresSimulatorTeam/antares-xpansion
[xpansion-doxygen]: https://antaressimulatorteam.github.io/antares-xpansion
[antares-github]: https://github.com/AntaresSimulatorTeam/Antares_Simulator
[readthedocs]: https://antares-xpansion.readthedocs.io/
[readthedocs-antares]: https://antares-doc.readthedocs.io/
Expand Down
Loading

0 comments on commit b19cd1b

Please sign in to comment.