Update formatting for interactive sessions in doc #60
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: | |
push: | |
branches: | |
- main | |
jobs: | |
build: | |
runs-on: windows-latest | |
steps: | |
- uses: actions/checkout@v2 | |
with: | |
fetch-depth: 0 | |
- uses: actions/setup-python@v2 | |
with: | |
python-version: '3.8' | |
architecture: 'x64' | |
- name: install wheel | |
run: pip install wheel | |
- uses: abatilo/[email protected] | |
- name: Install dependencies | |
run: | | |
poetry install --no-root | |
- name: Test docs | |
# I think all versions of docs ends up getting tested as long as all | |
# versions are tagged off of main. In other words, we don't need to run | |
# doctest for each version when we're building all the versions below | |
run: | | |
cd docs | |
poetry run sphinx-build -M doctest source html -c .\ | |
- name: Build docs | |
run: | | |
cd docs | |
./fullmake.bat | |
poetry run python make_redirect_index.py | |
New-Item build/html/.nojekyll | |
- name: Check GitHub Pages status | |
uses: crazy-max/ghaction-github-status@v2 | |
with: | |
pages_threshold: major_outage | |
- name: Deploy | |
if: success() | |
uses: crazy-max/ghaction-github-pages@v2 | |
with: | |
target_branch: gh-pages | |
build_dir: docs/build/html | |
env: | |
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} |