Merge pull request #2818 from deniszh/deniszh/readthedocs

Adding readthedocs config

.github/workflows/tests.yml

@@ -22,11 +22,11 @@ jobs:
         ports:
           - 3306/tcp
         env:
-          MYSQL_USER: graphite
-          MYSQL_PASSWORD: graphite
-          MYSQL_DATABASE: test_graphite
-          MYSQL_ROOT_PASSWORD: root
-        options: --health-cmd="mysqladmin ping" --health-interval=5s --health-timeout=2s --health-retries=3
+          MARIADB_USER: graphite
+          MARIADB_PASSWORD: graphite
+          MARIADB_DATABASE: test_graphite
+          MARIADB_ROOT_PASSWORD: root
+        options: --health-cmd="/usr/local/bin/healthcheck.sh --su-mysql --connect --innodb_initialized" --health-interval=5s --health-timeout=2s --health-retries=3
       postgres:
         image: postgres
         ports:
@@ -93,12 +93,12 @@ jobs:
         run: |
           tox
       - name: Run Codecov
-        if: ${{ matrix.python-version==3.9 }}
+        if: ${{ matrix.python-version==3.10 }}
         env:
           TOXENV: lint
         run: |
-          pip install codecov==2.1.12
+          pip install codecov
           codecov
       - name: Upload coverage to Codecov
-        if: ${{ matrix.python-version==3.9 }}
-        uses: codecov/codecov-action@v2
+        if: ${{ matrix.python-version==3.10 }}
+        uses: codecov/codecov-action@v3

.readthedocs.yaml

@@ -0,0 +1,22 @@
+# .readthedocs.yaml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Set the version of Python and other tools you might need
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.11"
+
+# Build documentation in the docs/ directory with Sphinx
+sphinx:
+  configuration: docs/conf.py
+
+# We recommend specifying your dependencies to enable reproducible builds:
+# https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
+python:
+   install:
+   - requirements: docs/requirements.txt

docs/requirements.txt

@@ -1,8 +1,14 @@
 ## Requirements for documentation
-Django>=1.11.19,<2.3
+cairocffi
 django-tagging==0.4.6
-sphinx
-sphinx_rtd_theme
 pytz
 git+https://github.com/graphite-project/whisper.git#egg=whisper
-scandir;python_version<"3.5"
+git+https://github.com/graphite-project/ceres.git#egg=ceres
+Django<5
+pyparsing>=3.0.6
+alabaster==0.7.12
+Sphinx==1.3.6
+jinja2<3.1.0
+sphinx_rtd_theme
+urllib3
+scandir;python_version<"3.5"

requirements.txt

@@ -35,7 +35,7 @@
 #   deactivate
 #
 
-Django>=3.2,<4
+Django>=3.2,<5
 python-memcached==1.58
 txAMQP==0.8
 django-tagging==0.4.6

tox.ini

@@ -34,7 +34,7 @@ deps =
 	git+https://github.com/graphite-project/whisper.git#egg=whisper
 	git+https://github.com/graphite-project/ceres.git#egg=ceres
 	pyparsing3: pyparsing>=3.0.6
-	django32: Django>=3.2,<4
+	django32: Django>=3.2,<5
 	urllib3
 	redis
 	rrdtool
@@ -52,7 +52,7 @@ deps =
 	pytz
 	git+https://github.com/graphite-project/whisper.git#egg=whisper
 	git+https://github.com/graphite-project/ceres.git#egg=ceres
-	Django<4
+	Django<5
 	pyparsing3: pyparsing>=3.0.6
 	alabaster==0.7.12
 	Sphinx==1.3.6