add readme image back in #3
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: deploy-docs | |
on: | |
push: | |
branches: | |
- main | |
paths: | |
- docs/** | |
- .github/workflows/deploy-docs.yaml | |
jobs: | |
deploy-docs: | |
runs-on: ubuntu-latest | |
permissions: | |
contents: write | |
defaults: | |
run: | |
shell: bash -el {0} | |
steps: | |
- uses: actions/checkout@v4 | |
- uses: conda-incubator/setup-miniconda@v3 | |
with: | |
auto-update-conda: true | |
python-version: "3.12" | |
- name: Install package | |
run: | | |
conda install -c conda-forge osmnx | |
pip install ".[dev]" | |
- name: Build book | |
run: | | |
jupyter-book build docs/ | |
# Push the book's HTML to github-pages | |
- name: GitHub Pages action | |
uses: peaceiris/actions-gh-pages@v3 | |
with: | |
github_token: ${{ secrets.GITHUB_TOKEN }} | |
publish_dir: ./docs/_build/html |