Skip to content

Commit 9a545b5

Browse files
committed
docs: repair docs and add very brief quickstart
1 parent 1fcb9ef commit 9a545b5

File tree

3 files changed

+39
-9
lines changed

3 files changed

+39
-9
lines changed

docs/source/index.rst

+37-2
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,49 @@
11
PocketSphinx Documentation
22
============================
33

4+
Welcome to the documentation for the Python interface to the
5+
PocketSphinx speech recognizer!
6+
7+
Quick Start
8+
-----------
9+
10+
To install PocketSphinx on most recent versions of Python, you should
11+
be able to simply use `pip`::
12+
13+
pip install pocketsphinx
14+
15+
This is a (somewhat) "batteries-included" install, which comes with a
16+
default model and dictionary. Sadly, this model is specifically for
17+
US (and, by extension Canadian) English, so it may not work well for
18+
your dialect and certainly won't work for your other language.
19+
20+
On Unix-like platforms you may need to install `PortAudio
21+
<https://portaudio.com>`_ for live audio input to work. Now you can
22+
try the simplest possible speech recognizer::
23+
24+
from pocketsphinx import LiveSpeech
25+
for phrase in LiveSpeech():
26+
print(phrase)
27+
28+
This will open the default audio device and start listening, detecting
29+
segments of speech and printing out the recognized text, which may or
30+
may not resemble what you actually said.
31+
32+
There are of course many other things you can do with it. See
33+
the :ref:`apidoc` for more information.
34+
35+
.. _apidoc:
36+
37+
API Documentation
38+
-----------------
39+
440
.. toctree::
541
:maxdepth: 2
6-
:caption: Contents:
742

8-
readme
943
pocketsphinx
1044
config_params
1145

46+
1247
Indices and tables
1348
==================
1449

docs/source/pocketsphinx5.rst docs/source/pocketsphinx.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
pocketsphinx package
2-
======================
1+
Main pocketsphinx package
2+
=========================
33

44
.. automodule:: pocketsphinx
55

docs/source/readme.rst

-5
This file was deleted.

0 commit comments

Comments
 (0)