Merge pull request #610 from FriendsOfCake/docs-build

Add config file for readthedocs

Author: ADmad

.gitattributes

@@ -11,3 +11,4 @@ docs export-ignore
 phpcs.xml export-ignore
 psalm.xml export-ignore
 phpstan.neon export-ignore
+.readthedocs.yml export-ignore

.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

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,