Skip to content

Commit

Permalink
Added RTD config file .readthedocs.yaml
Browse files Browse the repository at this point in the history
Signed-off-by: Andreas Maier <[email protected]>
  • Loading branch information
andy-maier committed Oct 15, 2023
1 parent 82c5a98 commit 31be00a
Show file tree
Hide file tree
Showing 3 changed files with 26 additions and 16 deletions.
24 changes: 24 additions & 0 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
# Read the Docs (RTD) configuration file
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details

# RTD config file version
version: 2

# Environment RTD sets up for the docs build
build:
os: ubuntu-22.04
tools:
python: "3.11"

# Build documentation in the docs/ directory with Sphinx
sphinx:
configuration: docs/conf.py

# If using Sphinx, optionally build your docs in additional formats such as PDF
# formats:
# - pdf

# Python requirements required to build the docs
python:
install:
- requirements: dev-requirements.txt
2 changes: 2 additions & 0 deletions docs/changes.rst
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,8 @@ Released: not yet
of them started installing a pre-release of a package on an unsupported Python
version. The recommendation has been for a while now to no longer use

* Docs: Added RTD config file .readthedocs.yaml

**Enhancements:**

* Improvements for safety check tool: Made passing the safety check mandatory;
Expand Down
16 changes: 0 additions & 16 deletions rtd-requirements.txt

This file was deleted.

0 comments on commit 31be00a

Please sign in to comment.