Skip to content

Commit

Permalink
Rename .readthedocs to match RTD
Browse files Browse the repository at this point in the history
  • Loading branch information
mcm001 committed Jul 1, 2024
1 parent dcc7ddc commit e7e59ed
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 15 deletions.
28 changes: 28 additions & 0 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
version: 2

sphinx:
builder: html
configuration: docs/source/conf.py
fail_on_warning: true

build:
os: ubuntu-22.04
tools:
python: "3.11"
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/master -- docs/ docs/.readthedocs.yaml;
then
exit 183;
fi
python:
install:
- requirements: docs/requirements.txt
15 changes: 0 additions & 15 deletions docs/.readthedocs.yml

This file was deleted.

0 comments on commit e7e59ed

Please sign in to comment.