modified docs

.idea/vcs.xml

@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="VcsDirectoryMappings">
+    <mapping directory="$PROJECT_DIR$" vcs="Git" />
+  </component>
+</project>

.travis.yml

@@ -22,8 +22,8 @@ deploy:
   distributions: sdist bdist_wheel
   user: nidhaloff
   password:
-    secure: PLEASE_REPLACE_ME
+    secure: __token__
   on:
     tags: true
     repo: nidhaloff/deep_translator
-    python: 3.8
+    python: 3.7

README.rst

@@ -41,6 +41,26 @@ Features
 * deep-translator uses google translate to translate a text. Therefore, all languages are supported
 * TODO: add support for the PONS translator (pons.com)
 
+
 Usage
------
-.. include:: docs/usage.rst
+=====
+
+To use deep_translator in a project::
+
+    from deep_translator import GoogleTranslator
+
+    english_text = 'happy coding'
+    chinese_text = '這很好'
+
+    # first create a GoogleTranslator object with source and target language
+    # then use the translate function to translate a text.
+    # All language are supported. Basic example:
+    result_german = GoogleTranslator(source='auto', target='de').translate(payload=english_text)
+    result_french = GoogleTranslator(source='auto', target='fr').translate(payload=chinese_text)
+
+    # Alternatively, you can pass languages by their name:
+    result_german = GoogleTranslator(source='english', target='german').translate(payload=english_text)
+    result_french = GoogleTranslator(source='auto', target='french').translate(payload=chinese_text)
+
+    # soon also support for the PONS translator.
+

docs/deep_translator.rst

@@ -0,0 +1,54 @@
+deep\_translator package
+========================
+
+Submodules
+----------
+
+deep\_translator.cli module
+---------------------------
+
+.. automodule:: deep_translator.cli
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+deep\_translator.constants module
+---------------------------------
+
+.. automodule:: deep_translator.constants
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+deep\_translator.deep\_translator module
+----------------------------------------
+
+.. automodule:: deep_translator.deep_translator
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+deep\_translator.exceptions module
+----------------------------------
+
+.. automodule:: deep_translator.exceptions
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+deep\_translator.models module
+------------------------------
+
+.. automodule:: deep_translator.models
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+
+Module contents
+---------------
+
+.. automodule:: deep_translator
+    :members:
+    :undoc-members:
+    :show-inheritance:

docs/modules.rst

@@ -0,0 +1,7 @@
+deep_translator
+===============
+
+.. toctree::
+   :maxdepth: 4
+
+   deep_translator

setup.py

@@ -10,7 +10,7 @@ with open('README.rst') as readme_file:
 with open('HISTORY.rst') as history_file:
     history = history_file.read()
 
-requirements = [ ]
+requirements = ['requests', 'bs4']
 
 setup_requirements = ['pytest-runner', ]