update docstring #787
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: CI | |
| on: | |
| push: | |
| branches: [main] | |
| pull_request: | |
| branches: [main] | |
| schedule: | |
| - cron: '0 6 * * 1' # Every Monday at 06:00 UTC | |
| jobs: | |
| build: | |
| name: Python ${{ matrix.python-version }} ${{ matrix.os }} | |
| runs-on: ${{ matrix.os }} | |
| strategy: | |
| fail-fast: false | |
| matrix: | |
| python-version: ['3.8', '3.9', '3.10', '3.11'] | |
| os: [ubuntu-latest] | |
| defaults: | |
| run: | |
| shell: bash -l {0} | |
| steps: | |
| - name: Checkout repo | |
| uses: actions/checkout@v3 | |
| with: | |
| fetch-depth: 2 | |
| - name: Setup Conda environment with Micromamba | |
| uses: mamba-org/provision-with-micromamba@v14 | |
| with: | |
| cache-downloads: true | |
| cache-env: true | |
| channels: conda-forge | |
| channel-priority: strict | |
| environment-file: environments/ci/env-tests.yml | |
| environment-name: env-tests | |
| extra-specs: python=${{ matrix.python-version }} | |
| - name: Install OSMnx | |
| run: | | |
| python setup.py install | |
| conda list | |
| conda info --all | |
| - name: Lint code | |
| run: | | |
| isort . --check-only | |
| black . --line-length 100 --check --diff | |
| flake8 . | |
| pydocstyle . | |
| - name: Test docs | |
| run: | | |
| make -C ./docs html | |
| python -m sphinx -b linkcheck docs/ docs/_build/linkcheck | |
| - name: Test code | |
| run: | | |
| coverage run --source ./osmnx --module pytest --verbose | |
| coverage xml -i | |
| coverage report -m | |
| - name: Upload coverage report | |
| uses: codecov/codecov-action@v3 |