Hugging Face's logo

Spaces:
davideuler
/
pdf-translator-for-human
Running

App Files Community
Chris Trenthem commited on
Commit
5384b5a
Β·
1 Parent(s): 7a13679

updated and cleaned documentation for v1.5.0

Browse files
Files changed (6) hide show
  1. docs/conf.py +1 -1
  2. docs/deep_translator.rst +0 -54
  3. docs/index.rst +2 -2
  4. docs/installation.rst +7 -3
  5. docs/modules.rst +103 -5
  6. docs/other_lang.rst +1 -1
docs/conf.py CHANGED
@@ -57,7 +57,7 @@ author = "Nidhal Baccouri"
57
  # the built documents.
58
  #
59
  # The short X.Y version.
60
- # version = deep_translator.__version__
61
  # The full version, including alpha/beta/rc tags.
62
  # release = deep_translator.__version__
63
 
 
57
  # the built documents.
58
  #
59
  # The short X.Y version.
60
+ version = '1.5.1-pre1'
61
  # The full version, including alpha/beta/rc tags.
62
  # release = deep_translator.__version__
63
 
docs/deep_translator.rst DELETED
@@ -1,54 +0,0 @@
1
- deep\_translator package
2
- ========================
3
-
4
- Submodules
5
- ----------
6
-
7
- deep\_translator.cli module
8
- ---------------------------
9
-
10
- .. automodule:: deep_translator.cli
11
- :members:
12
- :undoc-members:
13
- :show-inheritance:
14
-
15
- deep\_translator.constants module
16
- ---------------------------------
17
-
18
- .. automodule:: deep_translator.constants
19
- :members:
20
- :undoc-members:
21
- :show-inheritance:
22
-
23
- deep\_translator.deep\_translator module
24
- ----------------------------------------
25
-
26
- .. automodule:: deep_translator.deep_translator
27
- :members:
28
- :undoc-members:
29
- :show-inheritance:
30
-
31
- deep\_translator.exceptions module
32
- ----------------------------------
33
-
34
- .. automodule:: deep_translator.exceptions
35
- :members:
36
- :undoc-members:
37
- :show-inheritance:
38
-
39
- deep\_translator.models module
40
- ------------------------------
41
-
42
- .. automodule:: deep_translator.models
43
- :members:
44
- :undoc-members:
45
- :show-inheritance:
46
-
47
-
48
- Module contents
49
- ---------------
50
-
51
- .. automodule:: deep_translator
52
- :members:
53
- :undoc-members:
54
- :show-inheritance:
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
docs/index.rst CHANGED
@@ -1,6 +1,6 @@
1
 
2
  Welcome to deep_translator's documentation!
3
- ======================================
4
 
5
  If you see this doc in other languages,you can see :doc:`Choose languages</other_lang>`.
6
 
@@ -9,7 +9,7 @@ If you see this doc in other languages,you can see :doc:`Choose languages</other
9
  :caption: Contents:
10
  :name: mastertoc
11
 
12
- readme
13
  installation
14
  usage
15
  modules
 
1
 
2
  Welcome to deep_translator's documentation!
3
+ ===========================================
4
 
5
  If you see this doc in other languages,you can see :doc:`Choose languages</other_lang>`.
6
 
 
9
  :caption: Contents:
10
  :name: mastertoc
11
 
12
+ README
13
  installation
14
  usage
15
  modules
docs/installation.rst CHANGED
@@ -23,8 +23,8 @@ you through the process.
23
  .. _Python installation guide: http://docs.python-guide.org/en/latest/starting/installation/
24
 
25
 
26
- From sources
27
- ------------
28
 
29
  The sources for deep_translator can be downloaded from the `Github repo`_.
30
 
@@ -44,7 +44,11 @@ Once you have a copy of the source, you can install it with:
44
 
45
  .. code-block:: console
46
 
47
- $ python setup.py install
 
 
 
 
48
 
49
 
50
  .. _Github repo: https://github.com/nidhaloff/deep_translator
 
23
  .. _Python installation guide: http://docs.python-guide.org/en/latest/starting/installation/
24
 
25
 
26
+ From source code
27
+ ----------------
28
 
29
  The sources for deep_translator can be downloaded from the `Github repo`_.
30
 
 
44
 
45
  .. code-block:: console
46
 
47
+ $ pip install /path/to/tarball/tarball_name.tar.gz
48
+ <<< for tarball installations
49
+ $ poetry shell
50
+ $ poetry install
51
+ <<< for cloned repos
52
 
53
 
54
  .. _Github repo: https://github.com/nidhaloff/deep_translator
docs/modules.rst CHANGED
@@ -1,7 +1,105 @@
1
- deep_translator
2
- ===============
3
 
4
- .. toctree::
5
- :maxdepth: 4
6
 
7
- deep_translator
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ deep\_translator package
2
+ ========================
3
 
4
+ Submodules
5
+ ----------
6
 
7
+ CLI Module
8
+ ----------------------------
9
+
10
+ .. automodule:: deep_translator.main
11
+ :members:
12
+ :undoc-members:
13
+ :show-inheritance:
14
+
15
+ Exceptions
16
+ ----------------------------------
17
+
18
+ .. automodule:: deep_translator.exceptions
19
+ :members:
20
+ :undoc-members:
21
+ :show-inheritance:
22
+
23
+
24
+ Language Detection Library
25
+ ----------------------------------
26
+
27
+ .. automodule:: deep_translator.detection
28
+ :members:
29
+ :undoc-members:
30
+ :show-inheritance:
31
+
32
+ Translators
33
+ ============
34
+
35
+ Google Translator
36
+ ----------------------------------
37
+
38
+ .. automodule:: deep_translator.google_trans
39
+ :members:
40
+ :undoc-members:
41
+ :show-inheritance:
42
+
43
+ DeepL
44
+ ----------------------------------
45
+
46
+ .. automodule:: deep_translator.deepl
47
+ :members:
48
+ :undoc-members:
49
+ :show-inheritance:
50
+
51
+ Linguee
52
+ ----------------------------------
53
+
54
+ .. automodule:: deep_translator.linguee
55
+ :members:
56
+ :undoc-members:
57
+ :show-inheritance:
58
+
59
+ Microsoft/Bing Translate
60
+ ----------------------------------
61
+
62
+ .. automodule:: deep_translator.microsoft
63
+ :members:
64
+ :undoc-members:
65
+ :show-inheritance:
66
+
67
+ MyMemory
68
+ ----------------------------------
69
+
70
+ .. automodule:: deep_translator.mymemory
71
+ :members:
72
+ :undoc-members:
73
+ :show-inheritance:
74
+
75
+ Papago
76
+ ----------------------------------
77
+
78
+ .. automodule:: deep_translator.papago
79
+ :members:
80
+ :undoc-members:
81
+ :show-inheritance:
82
+
83
+ Pons
84
+ ----------------------------------
85
+
86
+ .. automodule:: deep_translator.pons
87
+ :members:
88
+ :undoc-members:
89
+ :show-inheritance:
90
+
91
+ QCRI
92
+ ----------------------------------
93
+
94
+ .. automodule:: deep_translator.qcri
95
+ :members:
96
+ :undoc-members:
97
+ :show-inheritance:
98
+
99
+ Yandex
100
+ ----------------------------------
101
+
102
+ .. automodule:: deep_translator.yandex
103
+ :members:
104
+ :undoc-members:
105
+ :show-inheritance:
docs/other_lang.rst CHANGED
@@ -7,4 +7,4 @@ English
7
 
8
  ζ—₯本θͺž
9
  --------------
10
- :doc:`ζ—₯本θͺžη‰ˆγƒ‰γ‚­γƒ₯γƒ‘γƒ³γƒˆ<./ja/index>`
 
7
 
8
  ζ—₯本θͺž
9
  --------------
10
+ :doc:`ζ—₯本θͺžη‰ˆγƒ‰γ‚­γƒ₯γƒ‘γƒ³γƒˆ<ja/index>`