Skip to content

Commit

Permalink
Merge pull request #697 from RasmusOrsoe/documentation_update2
Browse files Browse the repository at this point in the history
update documentation workflow
  • Loading branch information
RasmusOrsoe authored Apr 24, 2024
2 parents fb37ae9 + ada9dde commit 98400c4
Show file tree
Hide file tree
Showing 3 changed files with 24 additions and 6 deletions.
23 changes: 22 additions & 1 deletion .github/workflows/build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -144,4 +144,25 @@ jobs:
set -o pipefail # To propagate exit code from pytest
coverage run --source=graphnet -m pytest tests/ --ignore=tests/data/ --ignore=tests/deployment/ --ignore=tests/examples/ --ignore=tests/utilities
coverage run -a --source=graphnet -m pytest tests/utilities
coverage report -m
coverage report -m
docs:
name: Documentation Compilation
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- name: Install package
uses: ./.github/actions/install
- name: Build documentation
run: |
cd docs
make clean
sphinx-apidoc \
--module-first \
--separate \
--force \
-d 2 \
--templatedir=source/_templates/ \
-o source/api ../src/
sed -i "2s/.*/API/" source/api/graphnet.rst
make html
2 changes: 1 addition & 1 deletion .github/workflows/docker.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ env:

jobs:
docker:
name: Build and publish
name: Build and Publish Docker Image
if: github.repository == 'graphnet-team/graphnet'
runs-on: ubuntu-latest
permissions:
Expand Down
5 changes: 1 addition & 4 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ on:
# A workflow run is made up of one or more jobs that can run sequentially or in parallel
jobs:
docs:
name: Build and publish
name: Build and publish Documentation
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
Expand All @@ -22,9 +22,6 @@ jobs:
- name: Build documentation
run: |
cd docs
python parse_about.py -i ../paper/paper.md -o source/about.md
python parse_install.py -i ../README.md -o source/install.md
python parse_contributing.py -i ../CONTRIBUTING.md -o source/contribute.md
make clean
sphinx-apidoc \
--module-first \
Expand Down

0 comments on commit 98400c4

Please sign in to comment.