From a96bae1af9943c6f545d8aae5c3986b6cfa9148c Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Rub=C3=A9n=20Gonz=C3=A1lez=20Alonso?= <rgonalo@gmail.com>
Date: Wed, 10 Nov 2021 15:33:51 +0100
Subject: [PATCH] fix: fix doc compilation errors in readthedocs (#254)

---
 .readthedocs.yaml     | 20 ++++++++++++++++++++
 CHANGELOG.rst         |  2 ++
 README.rst            |  6 +++---
 docs/requirements.txt |  3 +++
 requirements_dev.txt  |  2 --
 5 files changed, 28 insertions(+), 5 deletions(-)
 create mode 100644 .readthedocs.yaml
 create mode 100644 docs/requirements.txt

diff --git a/.readthedocs.yaml b/.readthedocs.yaml
new file mode 100644
index 00000000..0c20da76
--- /dev/null
+++ b/.readthedocs.yaml
@@ -0,0 +1,20 @@
+# 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-20.04
+  tools:
+    python: "3.9"
+
+# Build documentation in the docs/ directory with Sphinx
+sphinx:
+  configuration: docs/conf.py
+
+# Optionally declare the Python requirements required to build your docs
+python:
+  install:
+    - requirements: docs/requirements.txt
diff --git a/CHANGELOG.rst b/CHANGELOG.rst
index cdaa0510..6858070c 100644
--- a/CHANGELOG.rst
+++ b/CHANGELOG.rst
@@ -8,6 +8,8 @@ v2.2.1
 
 - Add support for Python 3.10
 - Remove Python 3.5 support (Python 3.5 reached the end of its life on September 13th, 2020)
+- Move code quality check from codacy to codeclimate
+- Upgrade Sphinx version from 3.* to 4.* to fix doc compilation errors in readthedocs
 
 v2.2.0
 ------
diff --git a/README.rst b/README.rst
index b6590a63..9864c938 100644
--- a/README.rst
+++ b/README.rst
@@ -7,12 +7,12 @@ Toolium is a Python wrapper tool of Selenium and Appium libraries to test web an
 project. It provides a way of choosing and configuring the driver through a configuration file, implements a Page Object
 pattern and includes a simple visual testing solution.
 
-.. |Build Status| image:: https://github.com/Telefonica/toolium/workflows/build/badge.svg
-   :target: https://github.com/Telefonica/toolium/actions
+.. |Build Status| image:: https://github.com/Telefonica/toolium/workflows/build/badge.svg?branch=master
+   :target: https://github.com/Telefonica/toolium/actions?query=branch%3Amaster
 .. |Documentation Status| image:: https://readthedocs.org/projects/toolium/badge/?version=latest
    :target: http://toolium.readthedocs.org/en/latest
 .. |Coverage Status| image:: https://coveralls.io/repos/Telefonica/toolium/badge.svg?branch=master&service=github
-   :target: https://coveralls.io/github/Telefonica/toolium
+   :target: https://coveralls.io/github/Telefonica/toolium?branch=master
 .. |CodeClimate| image:: https://api.codeclimate.com/v1/badges/3e5773b2e5272b546f8a/maintainability
    :target: https://codeclimate.com/github/Telefonica/toolium/maintainability
 
diff --git a/docs/requirements.txt b/docs/requirements.txt
new file mode 100644
index 00000000..f3415ccf
--- /dev/null
+++ b/docs/requirements.txt
@@ -0,0 +1,3 @@
+Sphinx==4.*
+sphinx_rtd_theme==1.*
+readthedocs-sphinx-search==0.1.*
diff --git a/requirements_dev.txt b/requirements_dev.txt
index 16387f06..e82308d8 100644
--- a/requirements_dev.txt
+++ b/requirements_dev.txt
@@ -1,4 +1,3 @@
-Sphinx==3.*
 lettuce==0.2.23
 pytest==6.*
 coverage==5.*
@@ -6,6 +5,5 @@ coveralls==3.*
 mock==3.*
 requests-mock==1.*
 needle==0.5.0
-docutils==0.16  # imposed by Sphinx 3.*
 Pygments==2.*
 flake8==3.*