From ccae60e32e290068494919f75eeeb9109401643a Mon Sep 17 00:00:00 2001 From: Austin Bowen Date: Fri, 5 Jan 2024 14:48:14 -0500 Subject: [PATCH] chore(docs): Fix .readthedocs.yaml and update README.md (#445) * 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 --- .readthedocs.yml | 18 ++++++++++++++++++ README.md | 4 ++-- 2 files changed, 20 insertions(+), 2 deletions(-) diff --git a/.readthedocs.yml b/.readthedocs.yml index a94e857..c3b8572 100644 --- a/.readthedocs.yml +++ b/.readthedocs.yml @@ -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 diff --git a/README.md b/README.md index c8f055e..a2b6b34 100644 --- a/README.md +++ b/README.md @@ -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`. - + [![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/) @@ -33,7 +33,7 @@ Module: >>> tts = gTTS('hello') >>> tts.save('hello.mp3') -See for documentation and examples. +See for documentation and examples. ### Disclaimer