Skip to content

Fix Sphinx toctree warnings from included CHANGELOG.md #1978

Fix Sphinx toctree warnings from included CHANGELOG.md

Fix Sphinx toctree warnings from included CHANGELOG.md #1978

Workflow file for this run

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.10']
steps:
- uses: actions/checkout@v3
- name: Set up Python ${{ matrix.python-version }}
uses: actions/setup-python@v4
with:
python-version: ${{ matrix.python-version }}
cache: 'pip'
- 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