|
1 |
| -name: apidocs |
2 |
| -on: |
3 |
| -- push |
| 1 | +# name: apidocs |
| 2 | +# on: |
| 3 | +# - push |
4 | 4 |
|
5 |
| -jobs: |
6 |
| - deploy: |
7 |
| - runs-on: ubuntu-latest |
| 5 | +# jobs: |
| 6 | +# deploy: |
| 7 | +# runs-on: ubuntu-latest |
8 | 8 |
|
9 |
| - steps: |
10 |
| - - uses: actions/checkout@master |
11 |
| - - name: Set up Python 3.8 |
12 |
| - uses: actions/setup-python@v2 |
13 |
| - with: |
14 |
| - python-version: 3.8 |
| 9 | +# steps: |
| 10 | +# - uses: actions/checkout@master |
| 11 | +# - name: Set up Python 3.8 |
| 12 | +# uses: actions/setup-python@v2 |
| 13 | +# with: |
| 14 | +# python-version: 3.8 |
15 | 15 |
|
16 |
| - - name: Install requirements for documentation generation |
17 |
| - run: | |
18 |
| - python -m pip install --upgrade pip setuptools wheel |
19 |
| - python -m pip install pytest pydoctor>=22.3.0 . |
| 16 | +# - name: Install requirements for documentation generation |
| 17 | +# run: | |
| 18 | +# python -m pip install --upgrade pip setuptools wheel |
| 19 | +# python -m pip install pytest pydoctor>=22.3.0 . |
20 | 20 |
|
21 |
| - - name: Generate API documentation with pydoctor |
22 |
| - run: | |
| 21 | +# - name: Generate API documentation with pydoctor |
| 22 | +# run: | |
23 | 23 |
|
24 |
| - # Run simple pydoctor build |
25 |
| - pydoctor \ |
26 |
| - --project-name=PyDocSmith \ |
27 |
| - --project-url=https://github.com/$GITHUB_REPOSITORY \ |
28 |
| - --html-viewsource-base=https://github.com/$GITHUB_REPOSITORY/tree/$GITHUB_SHA \ |
29 |
| - --make-html \ |
30 |
| - --html-output=./apidocs \ |
31 |
| - --project-base-dir="." \ |
32 |
| - --docformat=restructuredtext \ |
33 |
| - --system-class=PyDocSmith.tests._pydoctor.HidesTestsPydoctorSystem \ |
34 |
| - --intersphinx=https://docs.python.org/3/objects.inv \ |
35 |
| - ./PyDocSmith |
| 24 | +# # Run simple pydoctor build |
| 25 | +# pydoctor \ |
| 26 | +# --project-name=PyDocSmith \ |
| 27 | +# --project-url=https://github.com/$GITHUB_REPOSITORY \ |
| 28 | +# --html-viewsource-base=https://github.com/$GITHUB_REPOSITORY/tree/$GITHUB_SHA \ |
| 29 | +# --make-html \ |
| 30 | +# --html-output=./apidocs \ |
| 31 | +# --project-base-dir="." \ |
| 32 | +# --docformat=restructuredtext \ |
| 33 | +# --system-class=PyDocSmith.tests._pydoctor.HidesTestsPydoctorSystem \ |
| 34 | +# --intersphinx=https://docs.python.org/3/objects.inv \ |
| 35 | +# ./PyDocSmith |
36 | 36 |
|
37 |
| - - name: Push API documentation to Github Pages |
38 |
| - uses: peaceiris/actions-gh-pages@v3 |
39 |
| - with: |
40 |
| - github_token: ${{ secrets.PYDOCSMITH_DEPLOY }} |
41 |
| - publish_dir: ./apidocs |
42 |
| - commit_message: "Generate API documentation" |
| 37 | +# - name: Push API documentation to Github Pages |
| 38 | +# uses: peaceiris/actions-gh-pages@v3 |
| 39 | +# with: |
| 40 | +# github_token: ${{ secrets.PYDOCSMITH_DEPLOY }} |
| 41 | +# publish_dir: ./apidocs |
| 42 | +# commit_message: "Generate API documentation" |
0 commit comments