Skip to content

Commit

Permalink
chore(docs): Fix .readthedocs.yaml and update README.md (#445)
Browse files Browse the repository at this point in the history
* Add optional connection timeout to gTTS constructor

* Fix bug where filtered tokens were unused

* Fix typos

* Remove _len function; it is not needed, as Python 2 is no longer supported

* Fix .readthedocs.yml and update README.md
  • Loading branch information
austin-bowen authored and pndurette committed Jan 5, 2024
1 parent 5b35510 commit ccae60e
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 2 deletions.
18 changes: 18 additions & 0 deletions .readthedocs.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,22 @@
# Read the Docs configuration file for Sphinx projects
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details

# Required
version: 2

# Set the OS, Python version and other tools you might need
build:
os: ubuntu-22.04
tools:
python: "3"

# Build documentation in the "docs/" directory with Sphinx
sphinx:
configuration: docs/conf.py

# Optional but recommended, declare the Python requirements required
# to build your documentation
# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
python:
install:
- method: pip
Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

**gTTS** (*Google Text-to-Speech*), a Python library and CLI tool to interface with Google Translate's text-to-speech API.
Write spoken `mp3` data to a file, a file-like object (bytestring) for further audio manipulation, or `stdout`.
<http://gtts.readthedocs.org/>
<https://gtts.readthedocs.io/>

[![PyPI version](https://img.shields.io/pypi/v/gTTS.svg)](https://pypi.org/project/gTTS/)
[![Python versions](https://img.shields.io/pypi/pyversions/gTTS.svg)](https://pypi.org/project/gTTS/)
Expand Down Expand Up @@ -33,7 +33,7 @@ Module:
>>> tts = gTTS('hello')
>>> tts.save('hello.mp3')

See <http://gtts.readthedocs.org/> for documentation and examples.
See <https://gtts.readthedocs.io/> for documentation and examples.

### Disclaimer

Expand Down

0 comments on commit ccae60e

Please sign in to comment.