29 lines
1.1 KiB
YAML
29 lines
1.1 KiB
YAML
# Read the Docs configuration file for MkDocs projects
|
|
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
|
|
# Required
|
|
version: 2
|
|
# Set the version of Python and other tools you might need
|
|
build:
|
|
os: ubuntu-lts-latest
|
|
tools:
|
|
python: latest
|
|
jobs:
|
|
post_checkout:
|
|
# Cancel building pull requests when there aren't changed in the docs directory or YAML file.
|
|
# You can add any other files or directories that you'd like here as well,
|
|
# like your docs requirements file, or other files that will change your docs build.
|
|
#
|
|
# If there are no changes (git diff exits with 0) we force the command to return with 183.
|
|
# This is a special exit code on Read the Docs that will cancel the build immediately.
|
|
- |
|
|
if [ "$READTHEDOCS_VERSION_TYPE" = "external" ] && git diff --quiet origin/main -- docs/ .readthedocs.yaml;
|
|
then
|
|
exit 183;
|
|
fi
|
|
mkdocs:
|
|
configuration: mkdocs.yml
|
|
# Optionally declare the Python requirements required to build your docs
|
|
python:
|
|
install:
|
|
- requirements: docs/requirements.txt
|