added docs config yaml

.readthedocs.yaml

@@ -0,0 +1,14 @@
+
+# File: .readthedocs.yaml
+
+version: 2
+
+# Build from the docs/ directory with Sphinx
+sphinx:
+  configuration: docs/conf.py
+
+# Explicitly set the version of Python and its requirements
+python:
+  version: 3.7
+  install:
+    - requirements: docs/requirements_docs.txt

docs/conf.py

@@ -58,7 +58,7 @@ author = "Nidhal Baccouri"
 # the built documents.
 #
 # The short X.Y version.
-with open("pyproject.toml", "r") as f:
+with open("../pyproject.toml", "r") as f:
     tom = toml.load(f)
 version = tom['tool']['poetry']['version']
 # The full version, including alpha/beta/rc tags.

docs/deep_translator.rst

@@ -1,54 +1,133 @@
 deep\_translator package
 ========================
 
-Submodules
-----------
+Subpackages
+-----------
 
-deep\_translator.cli module
----------------------------
+.. toctree::
+   :maxdepth: 4
 
-.. automodule:: deep_translator.cli
-    :members:
-    :undoc-members:
-    :show-inheritance:
+   deep_translator.tests
+
+Submodules
+----------
 
 deep\_translator.constants module
 ---------------------------------
 
 .. automodule:: deep_translator.constants
-    :members:
-    :undoc-members:
-    :show-inheritance:
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+deep\_translator.deepl module
+-----------------------------
+
+.. automodule:: deep_translator.deepl
+   :members:
+   :undoc-members:
+   :show-inheritance:
 
-deep\_translator.deep\_translator module
-----------------------------------------
+deep\_translator.detection module
+---------------------------------
 
-.. automodule:: deep_translator.deep_translator
-    :members:
-    :undoc-members:
-    :show-inheritance:
+.. automodule:: deep_translator.detection
+   :members:
+   :undoc-members:
+   :show-inheritance:
 
 deep\_translator.exceptions module
 ----------------------------------
 
 .. automodule:: deep_translator.exceptions
-    :members:
-    :undoc-members:
-    :show-inheritance:
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+deep\_translator.google\_trans module
+-------------------------------------
+
+.. automodule:: deep_translator.google_trans
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+deep\_translator.linguee module
+-------------------------------
+
+.. automodule:: deep_translator.linguee
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+deep\_translator.main module
+----------------------------
+
+.. automodule:: deep_translator.main
+   :members:
+   :undoc-members:
+   :show-inheritance:
 
-deep\_translator.models module
+deep\_translator.microsoft module
+---------------------------------
+
+.. automodule:: deep_translator.microsoft
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+deep\_translator.mymemory module
+--------------------------------
+
+.. automodule:: deep_translator.mymemory
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+deep\_translator.papago module
+------------------------------
+
+.. automodule:: deep_translator.papago
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+deep\_translator.parent module
 ------------------------------
 
-.. automodule:: deep_translator.models
-    :members:
-    :undoc-members:
-    :show-inheritance:
+.. automodule:: deep_translator.parent
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+deep\_translator.pons module
+----------------------------
+
+.. automodule:: deep_translator.pons
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+deep\_translator.qcri module
+----------------------------
+
+.. automodule:: deep_translator.qcri
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+deep\_translator.yandex module
+------------------------------
 
+.. automodule:: deep_translator.yandex
+   :members:
+   :undoc-members:
+   :show-inheritance:
 
 Module contents
 ---------------
 
 .. automodule:: deep_translator
-    :members:
-    :undoc-members:
-    :show-inheritance:
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/deep_translator.tests.rst

@@ -0,0 +1,69 @@
+deep\_translator.tests package
+==============================
+
+Submodules
+----------
+
+deep\_translator.tests.test\_cli module
+---------------------------------------
+
+.. automodule:: deep_translator.tests.test_cli
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+deep\_translator.tests.test\_deepl module
+-----------------------------------------
+
+.. automodule:: deep_translator.tests.test_deepl
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+deep\_translator.tests.test\_google\_trans module
+-------------------------------------------------
+
+.. automodule:: deep_translator.tests.test_google_trans
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+deep\_translator.tests.test\_linguee module
+-------------------------------------------
+
+.. automodule:: deep_translator.tests.test_linguee
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+deep\_translator.tests.test\_microsoft\_trans module
+----------------------------------------------------
+
+.. automodule:: deep_translator.tests.test_microsoft_trans
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+deep\_translator.tests.test\_mymemory module
+--------------------------------------------
+
+.. automodule:: deep_translator.tests.test_mymemory
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+deep\_translator.tests.test\_pons module
+----------------------------------------
+
+.. automodule:: deep_translator.tests.test_pons
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: deep_translator.tests
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/requirements_docs.txt

@@ -0,0 +1,14 @@
+pip==20.2.2
+bump2version==1.0.0
+wheel==0.35.1
+argh
+watchdog==0.10.3
+flake8==3.8.3
+coverage==5.2.1
+Sphinx==3.2.1
+twine==3.2.0
+Click==7.1.2
+pytest==6.0.1
+pytest-runner==5.2
+sphinx-copybutton==0.3.1
+importlib-metadata==1.6.0