Fix docstring #196
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: Docs | |
| on: | |
| pull_request: | |
| workflow_dispatch: | |
| inputs: | |
| debug_enabled: | |
| type: boolean | |
| description: Debug with tmate | |
| required: false | |
| default: false | |
| jobs: | |
| # This has been migrated to CircleCI | |
| # test: | |
| # runs-on: ubuntu-latest | |
| # strategy: | |
| # fail-fast: false | |
| # matrix: | |
| # python_version: ["3.10"] #["3.8", "3.9", "3.10", "3.11", "3.12"] | |
| # arangodb_config: ["single", "cluster"] | |
| # arangodb_license: ["community", "enterprise"] | |
| # arangodb_version: ["3.10.10", "3.11.4", "latest"] | |
| # name: Test (${{ matrix.python_version }}:${{ matrix.arangodb_config }}:${{ matrix.arangodb_license }}:${{ matrix.arangodb_version }}) | |
| # steps: | |
| # - name: Checkout code | |
| # uses: actions/checkout@v4 | |
| # - name: Set up Python | |
| # uses: actions/setup-python@v4 | |
| # with: | |
| # python-version: ${{ matrix.python_version }} | |
| # - name: Setup ArangoDB | |
| # run: | | |
| # chmod +x starter.sh | |
| # ./starter.sh ${{ matrix.arangodb_config }} ${{ matrix.arangodb_license }} ${{ matrix.arangodb_version }} | |
| # - name: Install Dependencies | |
| # run: pip install -e .[dev] | |
| # - name: List Docker Containers | |
| # run: docker ps -a | |
| # - name: Pytest | |
| # run: | | |
| # args=("--host" "localhost" "--port=8529") | |
| # if [ ${{ matrix.arangodb_config }} = "cluster" ]; then | |
| # args+=("--cluster" "--port=8539" "--port=8549") | |
| # fi | |
| # if [ ${{ matrix.arangodb_license }} = "enterprise" ]; then | |
| # args+=("--enterprise") | |
| # fi | |
| # echo "Running pytest with args: ${args[@]}" | |
| # pytest --cov=arango --cov-report=xml "${args[@]}" | |
| docs: | |
| runs-on: ubuntu-latest | |
| name: Docs | |
| steps: | |
| - name: Checkout repository | |
| uses: actions/checkout@v4 | |
| - name: Fetch all tags and branches | |
| run: git fetch --prune --unshallow | |
| - name: Create ArangoDB Docker container | |
| run: > | |
| docker create --name arango -p 8529:8529 -e ARANGO_ROOT_PASSWORD=passwd -v "$(pwd)/tests/static/":/tests/static | |
| arangodb/arangodb:latest --server.jwt-secret-keyfile=/tests/static/keyfile | |
| - name: Start ArangoDB Docker container | |
| run: docker start arango | |
| - name: Set up Python | |
| uses: actions/setup-python@v4 | |
| with: | |
| python-version: '3.10' | |
| - name: Debug with tmate | |
| uses: mxschmitt/action-tmate@v3 | |
| if: ${{ github.event_name == 'workflow_dispatch' && inputs.debug_enabled }} | |
| - name: Run pre-commit checks | |
| uses: pre-commit/[email protected] | |
| - name: Install dependencies | |
| run: pip install .[dev] | |
| - name: Run Sphinx doctest | |
| run: python -m sphinx -b doctest docs docs/_build | |
| # No longer needed as this is handled by Read the Docs | |
| #- name: Generate Sphinx HTML | |
| # run: python -m sphinx -b html -W docs docs/_build |