Skip to content

Commit

Permalink
fix: fix doc compilation errors in readthedocs
Browse files Browse the repository at this point in the history
  • Loading branch information
rgonalo committed Nov 10, 2021
1 parent b5c3763 commit 2d59838
Show file tree
Hide file tree
Showing 5 changed files with 28 additions and 5 deletions.
20 changes: 20 additions & 0 deletions .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
2 changes: 2 additions & 0 deletions CHANGELOG.rst
Expand Up @@ -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
------
Expand Down
6 changes: 3 additions & 3 deletions README.rst
Expand Up @@ -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

Expand Down
3 changes: 3 additions & 0 deletions docs/requirements.txt
@@ -0,0 +1,3 @@
Sphinx==4.*
sphinx_rtd_theme==1.*
readthedocs-sphinx-search==0.1.*
2 changes: 0 additions & 2 deletions requirements_dev.txt
@@ -1,11 +1,9 @@
Sphinx==3.*
lettuce==0.2.23
pytest==6.*
coverage==5.*
coveralls==3.*
mock==3.*
requests-mock==1.*
needle==0.5.0
docutils==0.16 # imposed by Sphinx 3.*
Pygments==2.*
flake8==3.*

0 comments on commit 2d59838

Please sign in to comment.