forked from project-codeflare/codeflare-sdk
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
aa0cc26
commit d0692a8
Showing
1 changed file
with
43 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,43 @@ | ||
name: documentation | ||
|
||
on: | ||
repository_dispatch: | ||
workflow_dispatch: | ||
|
||
permissions: | ||
contents: write | ||
|
||
jobs: | ||
docs: | ||
runs-on: ubuntu-latest | ||
steps: | ||
- uses: actions/checkout@v4 | ||
- name: Install Python | ||
uses: actions/setup-python@v5 | ||
with: | ||
python-version: 3.9 | ||
- name: Install Sphinx | ||
run: | | ||
sudo apt-get update | ||
sudo apt-get install sphinx-doc -y | ||
sudo apt-get install sphinx-common -y | ||
- name: Install Poetry | ||
uses: abatilo/actions-poetry@v2 | ||
with: | ||
poetry-version: 1.8.3 | ||
- name: Run poetry install | ||
run: poetry install --with docs | ||
- name: Create new documentation | ||
run: | | ||
pip install sphinx-rtd-theme==2.0.0 | ||
sphinx-apidoc -o docs/sphinx src/codeflare_sdk "**/*test_*" --force | ||
mkdir docs/sphinx/_static | ||
make clean -C docs/sphinx | ||
make html -C docs/sphinx | ||
- name: Deploy to GitHub Pages | ||
uses: peaceiris/actions-gh-pages@v3 | ||
with: | ||
publish_branch: sphinx-documentation | ||
github_token: ${{ secrets.GITHUB_TOKEN }} | ||
publish_dir: sphinx/_build/ | ||
force_orphan: true |