Fix the boilerplate for old generator and add a missing upgrade guide… #3120
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: Documentation | |
on: | |
push: | |
branches: | |
- main | |
paths: | |
- 'docs/**' | |
# Build pull requests | |
pull_request: | |
paths: | |
- 'docs/**' | |
- 'styles/**' | |
jobs: | |
docs: | |
name: Documentation | |
runs-on: ubuntu-latest | |
strategy: | |
matrix: | |
python-version: ['3.12'] | |
steps: | |
- uses: actions/checkout@v4 | |
- name: Set up Python ${{ matrix.python-version }} | |
uses: actions/setup-python@v5 | |
with: | |
python-version: ${{ matrix.python-version }} | |
cache: 'pip' | |
cache-dependency-path: 'requirements-docs.txt' | |
- name: Create Python virtual environment | |
run: pip install virtualenv | |
- name: pip install requirements | |
run: | | |
pip install -r requirements-docs.txt | |
sudo snap install --edge vale | |
- name: Check for broken links | |
run: make docs-linkcheckbroken | |
- name: Build HTML documentation | |
run: make docs-html | |
- name: Run vale | |
run: | | |
git clone https://github.com/errata-ai/Microsoft.git | |
cp -r ./Microsoft/Microsoft ./styles | |
vale --no-exit ./docs |