CMU Sphinx, called Sphinx in short is a group of speech recognition system developed at Carnegie Mellon University [Wikipedia].

This tutorial uses a simple Python project (Sample Project) to demonstrates how to use Sphinx to generate HTML-based documents. CMUSphinx Tutorial For Developers Introduction. This tutorial will focus on how to use pocketsphinx for speech to text in python. Projects integrating Sphinx functionality¶.

This is the third occasion that I’ve come to set up a Python package with all the trimmings, including nice looking Sphinx-backed documentation hosted on ReadTheDocs.

sourcedir must point to a Python package..

This tutorial is going to describe some applications of the CMUSphinx toolkit.

Getting Started¶. Sphinx is a documentation generator or a tool that translates a set of plain text source files into various output formats, automatically producing cross-references, indices, etc. Read the Docs, a software-as-a-service documentation hosting platform, uses Sphinx to automatically build documentation updates that are pushed to GitHub.. Spyder, the Scientific Python Development Environment, uses Sphinx in its help pane to render rich documentation for functions, classes and methods automatically or on-demand. Sphinx is a tool that makes it easy to create intelligent and beautiful documentation, written by Georg Brandl and licensed under the BSD license.

The main purpose of the Sample Project is not only to be a sample code for this Sphinx tutorial, but also to … That means that the module or the package must be in one of the directories on sys.path – adapt your sys.path in the configuration file accordingly. It was originally created for the Python documentation, and it has excellent facilities for the documentation of software projects in a range of languages. It is well documented by following NumPy style docstrings. The Sample Project is a simple binary search tree and binary tree traversal implementation. And my favourite feature, the "sphinx-apidoc" script, can walk through all your project's subdirectories and source files , and suck any docstrings from every single Python script it finds, automatically. It is also the third occasion where I’ve spent a few hours and a dozen commits trying to work out how I made everything work last time.

Using CMU Sphinx with python is a non complicated task, when you install all the relevant packages. For this to work, the docstrings must of course be written in correct reStructuredText. pyand all of your top-level RST text files. Installing Sphinx¶ Use pip to install Sphinx: pip install -U sphinx For other installation methods, see this installation guide by Sphinx. For Sphinx (actually, the Python interpreter that executes Sphinx) to find your module, it must be importable.

There's also a warning just below that in the docs: That is, if you have a directory containing a bunch of reStructuredText or Markdown documents, Sphinx can generate a series of HTML files, a PDF file (via LaTeX), man pages and much more.

An __init__.py file is required to make Python treat the directories as containing packages. Sphinx also has an autodoc/automodule feature, which can read the docstrings in your source code as reStructuredText and turn them into attractive HTML docs too. 1.Have your package’s top-level directory sit right next to your Sphinx Makefileand conf. This section covers the basics of how to create documentation using Sphinx and host the documentation for free in Read The Docs. What is CMU Sphinx and Pocketsphinx? Such applications could include voice control of your desktop, various automotive devices and intelligent houses.

Of course, this site is also created from reStructuredText sources using Sphinx! See Python tutorial documentation of packages.. My guess is that sphinx-apidoc recognizes your script as a script, not a package, because you omitted a __init__.py file. According to the docs for sphinx-apidoc:. Brandon’s Sphinx Tutorial, Release 2013.0 python-c'import your_package' There are three general approaches to making your package available to autodoc.