Skip to content

MNT: test the documentation generation workflow #305

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
glesur merged 7 commits into from
Dec 23, 2024
Merged

MNT: test the documentation generation workflow #305

Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
63f6a4a
test the documentation generation workflow
glesur Dec 20, 2024
af3d563
[pre-commit.ci lite] apply automatic fixes
pre-commit-ci-lite[bot] Dec 20, 2024
c060c41
update path
glesur Dec 20, 2024
c08fc76
typo
glesur Dec 20, 2024
3eaa696
add doxygen to the build
glesur Dec 20, 2024
dee00e5
doxygen again
glesur Dec 20, 2024
bfa54f7
clean naming
glesur Dec 20, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 24 additions & 0 deletions .github/workflows/idefix-ci-doc.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
name: Idefix CIs
on:
workflow_dispatch:
push:
branches:
- master
- develop
pull_request:
paths-ignore:
- '.github/ISSUE_TEMPLATE/*'


jobs:
ReadTheDocs:
runs-on: ubuntu-latest
steps:
- name: Check out repo
uses: actions/checkout@v3
- name: install doxygen
run: sudo apt-get install -y doxygen
- name: install python dependencies
run: python -m pip install --exists-action=w --no-cache-dir -r doc/python_requirements.txt
- name: compile documentation
run: python -m sphinx -T -b html -d _build/doctrees -D language=en doc/source doc/html
Loading