Merge pull request #84 from nidhaloff/docs

.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

deep_translator/__init__.py

@@ -17,13 +17,15 @@ __author__ = """Nidhal Baccouri"""
 __email__ = '[email protected]'
 __version__ = '1.5.0'
 
-__all__ = [GoogleTranslator,
-           PonsTranslator,
-           LingueeTranslator,
-           MyMemoryTranslator,
-           YandexTranslator,
-           MicrosoftTranslator,
-           QCRI,
-           DeepL,
-           single_detection,
-           batch_detection]
+__all__ = [
+    "GoogleTranslator",
+   "PonsTranslator",
+   "LingueeTranslator",
+   "MyMemoryTranslator",
+   "YandexTranslator",
+   "MicrosoftTranslator",
+   "QCRI",
+   "DeepL",
+   "single_detection",
+   "batch_detection"
+           ]

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:

{ja → docs/ja}/CONTRIBUTING.rst

@@ -47,10 +47,10 @@ deep_translator は、deep_translator の公式ドキュメントの一部、doc
 
 新しい機能を提案するときには、以下の項目を留意してください:
 
-* 新しい機能の動作をできるだけ詳しく説明してください。 
+* 新しい機能の動作をできるだけ詳しく説明してください。
 * 実装しやすいように機能の規模は限定するようにしてください。
 * このプロジェクトがボランティアから成り立っていることと、コントリビュートを歓迎する精神を忘れないでください。
-  
+
 
 開発環境の構築
 ------------
@@ -103,7 +103,7 @@ deep_translator は、deep_translator の公式ドキュメントの一部、doc
 
 
 ヒント
-----
+------
 
 テストのサブセットを実行するには以下のコマンドが利用できます::
 
@@ -111,7 +111,7 @@ $ pytest tests.test_deep_translator
 
 
 デプロイの方法
----------
+-------------
 
 メンテナンス担当者のためにデプロイの方法を記しておきます。まず、全ての変更がコミットされていることを確認してください。(HISTORY.rstのエントリを含む).
 次に、以下のコマンドを実行します::

{ja → docs/ja}/README.rst

@@ -88,9 +88,9 @@ Pythonを使用してテキストを別の言語に翻訳するタスクがあ
 * 異なる言語の異なる段落の翻訳を自動化する
 * コマンドラインから直接翻訳する（バージョン1.1.0以上）
 
-=============
+===============
 インストール方法
-=============
+===============
 
 ツールの安定版をインストールする方法です:
 
@@ -100,14 +100,15 @@ Pythonを使用してテキストを別の言語に翻訳するタスクがあ
 
 ソースからインストールを行いたい場合、ドキュメントを参照してください。
 
-=====
+=======
 使い方
-=====
+=======
 
 このセクションでは、このツールで様々な統合トランスレータを利用するデモを行います。このデモでは、google、pons、linguee、mymemoryの翻訳サービスを扱います（現時点）。将来的には、より多くの翻訳サービスを統合する予定です。
 
+==========
 インポート
-========
+==========
 
 .. code-block:: python
 
@@ -119,7 +120,7 @@ Pythonを使用してテキストを別の言語に翻訳するタスクがあ
 
 
 サポートされている言語を確認する
-==========================
+============================
 
 ポイント
 
@@ -295,9 +296,9 @@ deep_translatorの使用目的やpythonで翻訳をする方法を確認する
 
 https://medium.com/@nidhalbacc/how-to-translate-text-with-python-9d203139dcf5
 
-===========================
-スマートフォンアプリ Translator++ 
-===========================
+===============================
+スマートフォンアプリ Translator++
+===============================
 
 .. image:: ../../assets/app-icon.png
     :width: 100
@@ -340,9 +341,9 @@ Translator++はdeep_translatorパッケージがベースになっています
     :height: 300
     :alt: screenshot3
 
-==========
+=======================
 次のステップに進むためには
-==========
+=======================
 
 詳細は examples フォルダを確認してください。
 コントリビュートはいつでも歓迎しています。このパッケージが便利だと感じた方や使っている方がいたら、遠慮なくプルリクエストをしてフィードバックをください！

{ja → docs/ja}/installation.rst

@@ -1,8 +1,8 @@
 .. highlight:: shell
 
-============
+===============
 インストール方法
-============
+===============
 
 
 安定版

{ja → docs/ja}/usage.rst

@@ -1,6 +1,6 @@
-=====
+=======
 使い方
-=====
+=======
 
 .. code-block:: python
 

docs/other_lang.rst

@@ -1,5 +1,5 @@
 Choose Languages
-===============
+=================
 
 English
 --------------

docs/requirements_docs.txt

@@ -0,0 +1,15 @@
+pip==20.2.2
+bump2version==1.0.0
+wheel==0.35.1
+argh
+toml
+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