From 31be00a2b8cf0b64601ce4975430748ffc254f6a Mon Sep 17 00:00:00 2001 From: Andreas Maier Date: Sun, 15 Oct 2023 21:10:25 +0200 Subject: [PATCH] Added RTD config file .readthedocs.yaml Signed-off-by: Andreas Maier --- .readthedocs.yaml | 24 ++++++++++++++++++++++++ docs/changes.rst | 2 ++ rtd-requirements.txt | 16 ---------------- 3 files changed, 26 insertions(+), 16 deletions(-) create mode 100644 .readthedocs.yaml delete mode 100644 rtd-requirements.txt diff --git a/.readthedocs.yaml b/.readthedocs.yaml new file mode 100644 index 0000000..d1c070c --- /dev/null +++ b/.readthedocs.yaml @@ -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 diff --git a/docs/changes.rst b/docs/changes.rst index 392e39c..44ae7b4 100644 --- a/docs/changes.rst +++ b/docs/changes.rst @@ -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; diff --git a/rtd-requirements.txt b/rtd-requirements.txt deleted file mode 100644 index aa288cd..0000000 --- a/rtd-requirements.txt +++ /dev/null @@ -1,16 +0,0 @@ -# Pip requirements file for building docs of nocasedict project on RTD. -# -# The order of packages is significant, because pip processes them in the order -# of appearance. - -# Sphinx (no imports, invoked via sphinx-build script): -Sphinx>=4.2.0 -docutils>=0.16,<0.17 -sphinx-git>=10.1.1 -GitPython==2.1.1; python_version == '3.6' -GitPython==3.1.37; python_version >= '3.7' -sphinxcontrib-fulltoc>=1.2.0 -sphinxcontrib-websupport>=1.1.2 -Pygments>=2.1.3 -sphinx-rtd-theme>=1.0.0 -Babel>=2.7.0