Improve grpc troubleshooting documentation #3951
Workflow file for this run
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
| name: Documentation Build | |
| on: [pull_request, workflow_dispatch] | |
| env: | |
| # Following env vars when changed will "reset" the mentioned cache, | |
| # by changing the cache file name. It is rendered as ...-v%RESET_XXX%-... | |
| # You should go up in number, if you go down (or repeat a previous value) | |
| # you might end up reusing a previous cache if it haven't been deleted already. | |
| # It applies 7 days retention policy by default. | |
| RESET_EXAMPLES_CACHE: 3 | |
| RESET_DOC_BUILD_CACHE: 3 | |
| RESET_AUTOSUMMARY_CACHE: 3 | |
| concurrency: | |
| group: ${{ github.workflow }}-${{ github.ref }} | |
| cancel-in-progress: true | |
| jobs: | |
| docs-style: | |
| name: Documentation Style Check | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v3 | |
| - name: Running Vale | |
| uses: errata-ai/vale-action@reviewdog | |
| env: | |
| GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}} | |
| with: | |
| files: doc | |
| reporter: github-pr-check | |
| level: error | |
| filter_mode: nofilter | |
| fail_on_error: true | |
| vale_flags: "--config=doc/.vale.ini" | |
| docs_build: | |
| runs-on: ubuntu-20.04 | |
| steps: | |
| - uses: actions/checkout@v3 | |
| - name: Setup Python | |
| uses: actions/setup-python@v4 | |
| with: | |
| python-version: 3.8 | |
| - name: Install pyaedt | |
| run: | | |
| pip install . | |
| - name: Verify pyaedt can be imported | |
| run: python -c "import pyaedt" | |
| - name: Retrieve PyAEDT version | |
| id: version | |
| run: | | |
| echo "::set-output name=PYAEDT_VERSION::$(python -c "from pyaedt import __version__; print(__version__)")" | |
| echo "PyAEDT version is: $(python -c "from pyaedt import __version__; print(__version__)")" | |
| # - name: Cache docs build directory | |
| # uses: actions/cache@v3 | |
| # with: | |
| # path: doc/build | |
| # key: doc-build-v${{ env.RESET_DOC_BUILD_CACHE }}-${{ steps.version.outputs.PYAEDT_VERSION }}-${{ github.sha }} | |
| # restore-keys: | | |
| # doc-build-v${{ env.RESET_DOC_BUILD_CACHE }}-${{ steps.version.outputs.PYAEDT_VERSION }} | |
| # - name: Cache autosummary | |
| # uses: actions/cache@v3 | |
| # with: | |
| # path: doc/source/**/_autosummary/*.rst | |
| # key: autosummary-v${{ env.RESET_AUTOSUMMARY_CACHE }}-${{ steps.version.outputs.PYAEDT_VERSION }}-${{ github.sha }} | |
| # restore-keys: | | |
| # autosummary-v${{ env.RESET_AUTOSUMMARY_CACHE }}-${{ steps.version.outputs.PYAEDT_VERSION }} | |
| - name: Install doc build requirements | |
| run: | | |
| pip install .[doc] | |
| sudo apt install graphviz | |
| # run doc build, without creating the examples directory | |
| # note that we have to add the examples file here since it won't | |
| # be created as gallery is disabled on linux. | |
| - name: Documentation Build | |
| run: | | |
| mkdir doc/source/examples -p | |
| echo $'Examples\n========' > doc/source/examples/index.rst | |
| make -C doc html SPHINXOPTS="-j auto -w build_errors.txt -N" | |
| # Verify that sphinx generates no warnings | |
| - name: Check for warnings | |
| run: | | |
| python doc/print_errors.py | |
| # - name: Upload Documentation | |
| # uses: actions/upload-artifact@v3 | |
| # with: | |
| # name: Documentation | |
| # path: doc/_build/html | |
| # retention-days: 7 |