Merge pull request #5 from matheusfelipeog/feat/integration-of-readthedocs-config

Integration of readthedocs config file

Author: matheusfelipeog

.readthedocs.yml

@@ -0,0 +1,25 @@
+# .readthedocs.yml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Select the Docker image used for building the docs.
+build:
+  image: latest
+
+# Build documentation in the docs/ directory with Sphinx
+sphinx:
+  builder: html
+  configuration: docs/source/conf.py
+  fail_on_warning: true
+
+# Build all formats (htmlzip, pdf and epub)
+formats: all
+
+# Configure python for install requirements
+python:
+  version: 3.8
+  install:
+    - requirements: docs/docs_requirements.txt

docs/docs_requirements.txt

@@ -0,0 +1 @@
+requests-html==0.10.0

worldometer/core.py

@@ -136,11 +136,7 @@
 
 
 class Worldometer(object):
-    """
-    Worldometer Class
-    -----------------
-
-    This is the core class of the worldometer module.
+    """This is the core class of the worldometer module.
 
     All functions/methods of the worldometer module use 
     this class to build a Worldometer Object to access the collected data.