|
1 |
| -# This workflow automatically generates the Sphinx documentation required for |
2 |
| -# GitHub pages. Executed when main is pushed to. |
3 |
| -name: Documentation update |
4 |
| -on: |
5 |
| - push: |
6 |
| - branches: main |
7 |
| - workflow_dispatch: |
| 1 | +# # This workflow automatically generates the Sphinx documentation required for |
| 2 | +# # GitHub pages. Executed when main is pushed to. |
| 3 | +# name: Documentation update |
| 4 | +# on: |
| 5 | +# push: |
| 6 | +# branches: main |
| 7 | +# workflow_dispatch: |
8 | 8 |
|
9 |
| -jobs: |
10 |
| - build: |
11 |
| - runs-on: ubuntu-latest |
12 |
| - steps: |
13 |
| - - uses: actions/setup-python@v2 |
14 |
| - with: |
15 |
| - python-version: '3.8' |
| 9 | +# jobs: |
| 10 | +# build: |
| 11 | +# runs-on: ubuntu-latest |
| 12 | +# steps: |
| 13 | +# - uses: actions/setup-python@v2 |
| 14 | +# with: |
| 15 | +# python-version: '3.8' |
16 | 16 |
|
17 |
| - # Checkout the main branch (docs will be built from this) |
18 |
| - - uses: actions/checkout@v2 |
19 |
| - with: |
20 |
| - path: main |
21 |
| - # Checkout the documentation branch (docs will be pushed to this) |
22 |
| - - uses: actions/checkout@v2 |
23 |
| - with: |
24 |
| - ref: gh-pages |
25 |
| - path: gh-pages |
| 17 | +# # Checkout the main branch (docs will be built from this) |
| 18 | +# - uses: actions/checkout@v2 |
| 19 | +# with: |
| 20 | +# path: main |
| 21 | +# # Checkout the documentation branch (docs will be pushed to this) |
| 22 | +# - uses: actions/checkout@v2 |
| 23 | +# with: |
| 24 | +# ref: gh-pages |
| 25 | +# path: gh-pages |
26 | 26 |
|
27 |
| - - name: Install Sphinx requirements |
28 |
| - working-directory: ${{ github.workspace }}/main/docs |
29 |
| - run: | |
30 |
| - sudo apt-get update -y |
31 |
| - sudo apt-get install -y pandoc |
32 |
| - python -m pip install --upgrade pip |
33 |
| - python -m pip install -r requirements.txt |
34 |
| - - name: Build documentation |
35 |
| - working-directory: ${{ github.workspace }}/main/docs |
36 |
| - run: make html |
| 27 | +# - name: Install Sphinx requirements |
| 28 | +# working-directory: ${{ github.workspace }}/main/docs |
| 29 | +# run: | |
| 30 | +# sudo apt-get update -y |
| 31 | +# sudo apt-get install -y pandoc |
| 32 | +# python -m pip install --upgrade pip |
| 33 | +# python -m pip install -r requirements.txt |
| 34 | +# - name: Build documentation |
| 35 | +# working-directory: ${{ github.workspace }}/main/docs |
| 36 | +# run: make html |
37 | 37 |
|
38 |
| - - name: Move documentation |
39 |
| - run: | |
40 |
| - touch main/docs/build/html/.nojekyll |
41 |
| - cp -a main/docs/build/html/. gh-pages/ |
42 |
| - - name: Upload documentation |
43 |
| - working-directory: ${{ github.workspace }}/gh-pages |
44 |
| - run: | |
45 |
| - git config --local user.email "action@github.com" |
46 |
| - git config --local user.name "GitHub Action" |
47 |
| - git add --all |
48 |
| - git diff-index --quiet HEAD || git commit -m "docs update" -a |
49 |
| - git push |
| 38 | +# - name: Move documentation |
| 39 | +# run: | |
| 40 | +# touch main/docs/build/html/.nojekyll |
| 41 | +# cp -a main/docs/build/html/. gh-pages/ |
| 42 | +# - name: Upload documentation |
| 43 | +# working-directory: ${{ github.workspace }}/gh-pages |
| 44 | +# run: | |
| 45 | +# git config --local user.email "action@github.com" |
| 46 | +# git config --local user.name "GitHub Action" |
| 47 | +# git add --all |
| 48 | +# git diff-index --quiet HEAD || git commit -m "docs update" -a |
| 49 | +# git push |
0 commit comments