Updated docs

docs/deep_translator.rst

@@ -0,0 +1,133 @@
+deep\_translator package
+========================
+
+Submodules
+----------
+
+deep\_translator.constants module
+---------------------------------
+
+.. automodule:: deep_translator.constants
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+deep\_translator.deepl module
+-----------------------------
+
+.. automodule:: deep_translator.deepl
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+deep\_translator.detection module
+---------------------------------
+
+.. automodule:: deep_translator.detection
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+deep\_translator.exceptions module
+----------------------------------
+
+.. automodule:: deep_translator.exceptions
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+deep\_translator.google\_trans module
+-------------------------------------
+
+.. automodule:: deep_translator.google_trans
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+deep\_translator.libre module
+-----------------------------
+
+.. automodule:: deep_translator.libre
+   :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.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.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:

docs/usage.rst

@@ -300,6 +300,43 @@ Yandex Translator
 
     translated = YandexTranslator('your_api_key').translate_batch(source="auto", target="de", batch=["hello world", "happy coding"])
 
+Libre Translator
+---------------------
+
+.. note::
+
+    Libre translate has multiple  `mirrors <https://github.com/LibreTranslate/LibreTranslate#mirrors/>`_ which can be used for the API endpoint.
+    Some require an API key to be used. By default the base url is set to `libretranslate.de <https://libretranslate.de/>`_ . 
+    This can be set using the "base_url" input parameter.
+
+.. code-block:: python
+
+    text = 'laufen'
+    translated = LibreTranslator(source='auto', target='en', base_url = 'https://libretranslate.com/', api_key = 'your_api_key').translate(text=text)  # output: run
+
+
+- You can pass languages by name or by abbreviation:
+
+.. code-block:: python
+
+    translated = LibreTranslator(source='german', target='english').translate(text=text)
+
+    # Alternatively, you can pass languages by their abbreviation:
+    translated = LibreTranslator(source='de', target='en').translate(text=text)
+
+
+- Translate batch of texts
+
+.. code-block:: python
+
+    texts = ["hallo welt", "guten morgen"]
+    translated = LibreTranslator(source='auto', target='en').translate_batch(texts)
+
+- Translate from a file:
+
+.. code-block:: python
+
+    translated = LibreTranslator(source='auto', target='en').translate_file('path/to/file')
 
 Usage from Terminal
 --------------------