Skip to content

Commit

Permalink
Fix documentation reference
Browse files Browse the repository at this point in the history
Keep CNAME file
Add docs build badge in README.md
  • Loading branch information
dormant-user committed Sep 9, 2023
1 parent 78410cb commit 1eed6f2
Show file tree
Hide file tree
Showing 6 changed files with 35 additions and 27 deletions.
7 changes: 5 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,10 +13,13 @@
[![](https://img.shields.io/pypi/v/py3-tts.svg?style=plastic)](https://pypi.org/project/py3-tts/)
[![](https://img.shields.io/github/languages/top/thevickypedia/py3-tts.svg?style=plastic)](https://github.com/thevickypedia/py3-tts)

[![](https://img.shields.io/badge/author-thevickypedia-green.svg)](https://github.com/thevickypedia)
[![](https://github.com/thevickypedia/py3-tts/actions/workflows/pythonpublish.yml/badge.svg)](https://github.com/thevickypedia/py3-tts/actions/workflows/pythonpublish.yml)
[![](https://github.com/thevickypedia/py3-tts/actions/workflows/pages/pages-build-deployment/badge.svg)](https://github.com/thevickypedia/py3-tts/actions/workflows/pages/pages-build-deployment)

`py3-tts` is a text-to-speech conversion library in Python. Unlike alternative libraries, **it works offline**.
[![](https://img.shields.io/badge/re_implementer-thevickypedia-blue.svg)](https://github.com/thevickypedia)
[![](https://img.shields.io/badge/author-nateshmbhat-orange.svg)](https://github.com/nateshmbhat)

`py3-tts` (originally [`pyttsx3`](https://github.com/nateshmbhat/pyttsx3)) is a text-to-speech conversion library in Python. Unlike alternative libraries, **it works offline**.

## Installation

Expand Down
8 changes: 4 additions & 4 deletions doc_generator/install.rst
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ On OSX or Linux
Using pip to install in a virtualenv
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

If you have virtualenv_ installed with pip_, you can use pip to install a copy of pyttsx3 in the virtual environment folder.
If you have virtualenv_ installed with pip_, you can use pip to install a copy of py3-tts in the virtual environment folder.

On Windows
##########
Expand Down Expand Up @@ -66,15 +66,15 @@ Unless you wish to compile your own version of pyobjc (a lengthy process), you w
$ . myproj/bin/activate
(myproj)$ pip install py3-tts
...
Successfully installed pyttsx3
Successfully installed py3-tts
Cleaning up...
On Linux
########

pyttsx3 requires no Python dependencies on Linux. You can cut-off the pyttsx3 virtualenv from the system site-packages.

code-block:: bash
.. code-block:: bash
$ virtualenv --no-site-packages myproj
New python executable in myproj/bin/python
Expand All @@ -83,7 +83,7 @@ code-block:: bash
$ . myproj/bin/activate
(myproj)$ pip install py3-tts
...
Successfully installed pyttsx3
Successfully installed py3-tts
Cleaning up...
Expand Down
8 changes: 4 additions & 4 deletions docs/_sources/install.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ On OSX or Linux
Using pip to install in a virtualenv
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

If you have virtualenv_ installed with pip_, you can use pip to install a copy of pyttsx3 in the virtual environment folder.
If you have virtualenv_ installed with pip_, you can use pip to install a copy of py3-tts in the virtual environment folder.

On Windows
##########
Expand Down Expand Up @@ -66,15 +66,15 @@ Unless you wish to compile your own version of pyobjc (a lengthy process), you w
$ . myproj/bin/activate
(myproj)$ pip install py3-tts
...
Successfully installed pyttsx3
Successfully installed py3-tts
Cleaning up...
On Linux
########

pyttsx3 requires no Python dependencies on Linux. You can cut-off the pyttsx3 virtualenv from the system site-packages.

code-block:: bash
.. code-block:: bash
$ virtualenv --no-site-packages myproj
New python executable in myproj/bin/python
Expand All @@ -83,7 +83,7 @@ code-block:: bash
$ . myproj/bin/activate
(myproj)$ pip install py3-tts
...
Successfully installed pyttsx3
Successfully installed py3-tts
Cleaning up...
Expand Down
27 changes: 13 additions & 14 deletions docs/install/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ <h3>On OSX or Linux<a class="headerlink" href="#on-osx-or-linux" title="Permalin
</section>
<section id="using-pip-to-install-in-a-virtualenv">
<h2>Using pip to install in a virtualenv<a class="headerlink" href="#using-pip-to-install-in-a-virtualenv" title="Permalink to this heading"></a></h2>
<p>If you have <a class="reference external" href="https://pypi.python.org/pypi/virtualenv/1.10.1">virtualenv</a> installed with <a class="reference external" href="https://pypi.python.org/pypi/pip">pip</a>, you can use pip to install a copy of pyttsx3 in the virtual environment folder.</p>
<p>If you have <a class="reference external" href="https://pypi.python.org/pypi/virtualenv/1.10.1">virtualenv</a> installed with <a class="reference external" href="https://pypi.python.org/pypi/pip">pip</a>, you can use pip to install a copy of py3-tts in the virtual environment folder.</p>
<section id="id1">
<h3>On Windows<a class="headerlink" href="#id1" title="Permalink to this heading"></a></h3>
<p>You’ll need to install the <a class="reference external" href="http://sourceforge.net/projects/pywin32/files/pywin32/">pywin32-extensions</a> package system-wide using its Windows installer. Then you’ll need to give your virtualenv access to the system site-packages in order to install py3-tts.</p>
Expand All @@ -87,26 +87,25 @@ <h3>On OSX<a class="headerlink" href="#on-osx" title="Permalink to this heading"
$<span class="w"> </span>.<span class="w"> </span>myproj/bin/activate
<span class="o">(</span>myproj<span class="o">)</span>$<span class="w"> </span>pip<span class="w"> </span>install<span class="w"> </span>py3-tts
...
Successfully<span class="w"> </span>installed<span class="w"> </span>pyttsx3
Successfully<span class="w"> </span>installed<span class="w"> </span>py3-tts
Cleaning<span class="w"> </span>up...
</pre></div>
</div>
</section>
<section id="on-linux">
<h3>On Linux<a class="headerlink" href="#on-linux" title="Permalink to this heading"></a></h3>
<p>pyttsx3 requires no Python dependencies on Linux. You can cut-off the pyttsx3 virtualenv from the system site-packages.</p>
<p>code-block:: bash</p>
<blockquote>
<div><p>$ virtualenv –no-site-packages myproj
New python executable in myproj/bin/python
Installing setuptools…………done.
Installing pip……………done.
$ . myproj/bin/activate
(myproj)$ pip install py3-tts
Successfully installed pyttsx3
Cleaning up…</p>
</div></blockquote>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>$<span class="w"> </span>virtualenv<span class="w"> </span>--no-site-packages<span class="w"> </span>myproj
New<span class="w"> </span>python<span class="w"> </span>executable<span class="w"> </span><span class="k">in</span><span class="w"> </span>myproj/bin/python
Installing<span class="w"> </span>setuptools............done.
Installing<span class="w"> </span>pip...............done.
$<span class="w"> </span>.<span class="w"> </span>myproj/bin/activate
<span class="o">(</span>myproj<span class="o">)</span>$<span class="w"> </span>pip<span class="w"> </span>install<span class="w"> </span>py3-tts
...
Successfully<span class="w"> </span>installed<span class="w"> </span>py3-tts
Cleaning<span class="w"> </span>up...
</pre></div>
</div>
</section>
</section>
</section>
Expand Down
Loading

0 comments on commit 1eed6f2

Please sign in to comment.