From 14693c9b6d5a8a5ac00fcaba6e69e01007ba8701 Mon Sep 17 00:00:00 2001 From: ADmad Date: Wed, 2 Oct 2024 23:29:38 +0530 Subject: [PATCH] Add config file for readthedocs --- .gitattributes | 1 + .readthedocs.yaml | 35 +++++++++++++++++++++++++++++++++++ docs/conf.py | 4 ++-- 3 files changed, 38 insertions(+), 2 deletions(-) create mode 100644 .readthedocs.yaml diff --git a/.gitattributes b/.gitattributes index a399e5d7..e0984878 100644 --- a/.gitattributes +++ b/.gitattributes @@ -11,3 +11,4 @@ docs export-ignore phpcs.xml export-ignore psalm.xml export-ignore phpstan.neon export-ignore +.readthedocs.yml export-ignore diff --git a/.readthedocs.yaml b/.readthedocs.yaml new file mode 100644 index 00000000..38cb31b6 --- /dev/null +++ b/.readthedocs.yaml @@ -0,0 +1,35 @@ +# Read the Docs configuration file for Sphinx projects +# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details + +# Required +version: 2 + +# Set the OS, Python version and other tools you might need +build: + os: ubuntu-22.04 + tools: + python: "3.9" + # You can also specify other tool versions: + # nodejs: "20" + # rust: "1.70" + # golang: "1.20" + +# Build documentation in the "docs/" directory with Sphinx +sphinx: + configuration: docs/conf.py + # You can configure Sphinx to use a different builder, for instance use the dirhtml builder for simpler URLs + # builder: "dirhtml" + # Fail on all warnings to avoid broken references + # fail_on_warning: true + +# Optionally build your docs in additional formats such as PDF and ePub +formats: + - pdf + - epub + +# Optional but recommended, declare the Python requirements required +# to build your documentation +# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html +python: + install: + - requirements: docs/requirements.txt diff --git a/docs/conf.py b/docs/conf.py index 4c81af7e..7514e94d 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -14,8 +14,8 @@ project = u'cakephp-upload' project_pretty_name = u'CakePHP Upload' copyright = u'%d, Jose Diaz-Gonzalez' % datetime.datetime.now().year -version = '3.0.0' -release = '3.0.0' +version = '8.0' +release = '8.0' html_title = 'CakePHP Upload' html_context = { 'maintainer': maintainer,