Merge pull request #716 from FriendsOfCake/docs-build

Add config file for readthedocs

Author: ADmad

.gitattributes

@@ -10,3 +10,4 @@ phpunit.xml.dist export-ignore
 tests export-ignore
 docs export-ignore
 .github export-ignore
+.readthedocs.yaml 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.12"
+    # 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

@@ -19,9 +19,9 @@
 project = u'crud'
 project_pretty_name = u'Crud'
 copyright = u'%d, Friends of Cake' % datetime.datetime.now().year
-version = '5.0'
-release = '5.0'
-html_title = 'Crud v5'
+version = '7.0'
+release = '7.0'
+html_title = 'Crud v7'
 html_context = {
     'maintainer': maintainer,
     'project_pretty_name': project_pretty_name,