Add doctest instructions (#414) #156
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
| # This action renders and publishes the development docs whenever | |
| # new commits are added to the master bracnh. | |
| name: BuildDeployDevDocs | |
| on: | |
| # Runs on pushes targeting the default branch | |
| push: | |
| branches: ["master"] | |
| # Allows you to run this workflow manually from the Actions tab | |
| workflow_dispatch: | |
| # Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages | |
| permissions: | |
| contents: read | |
| pages: write | |
| deployments: write | |
| id-token: write | |
| # Allow one concurrent deployment | |
| concurrency: | |
| group: "pages" | |
| cancel-in-progress: true | |
| jobs: | |
| # Build job | |
| build: | |
| runs-on: ubuntu-latest | |
| environment: | |
| name: github-pages | |
| url: ${{ steps.deployment.outputs.page_url }} | |
| steps: | |
| - uses: actions/checkout@v4 | |
| with: | |
| fetch-depth: 0 | |
| - name: "get tags" | |
| run: | | |
| git fetch --tags --force # Retrieve annotated tags. | |
| - name: Setup conda | |
| uses: conda-incubator/setup-miniconda@v3 | |
| with: | |
| mamba-version: "*" | |
| channels: conda-forge,defaults | |
| channel-priority: true | |
| python-version: "3.10" | |
| activate-environment: dascore | |
| environment-file: environment.yml | |
| condarc-file: .github/test_condarc.yml | |
| - name: install dascore with docbuild reqs | |
| shell: bash -l {0} | |
| run: | | |
| conda install -c conda-forge pandoc | |
| python -m pip install -e .[docs] | |
| - name: Install quarto | |
| uses: quarto-dev/quarto-actions/setup@v2 | |
| with: | |
| version: 1.3.450 | |
| tinytex: true | |
| - name: print quarto version | |
| run: | | |
| quarto --version | |
| - name: render API docs | |
| shell: bash -l {0} | |
| run: | | |
| python scripts/build_api_docs.py | |
| - name: publish docs to netlify | |
| shell: bash -l {0} | |
| env: | |
| QUARTO_PRINT_STACK: true | |
| NETLIFY_AUTH_TOKEN: ${{ secrets.NETLIFY_AUTH_TOKEN }} | |
| run: | | |
| quarto publish docs --no-prompt --no-browser |