Skip to content

Commit

Permalink
Minor changes to get docs to compile correctly
Browse files Browse the repository at this point in the history
Also, added Makefile back in to do local builds of the docs.
  • Loading branch information
mmabey committed Aug 2, 2017
1 parent 1abc388 commit f84b792
Show file tree
Hide file tree
Showing 5 changed files with 32 additions and 7 deletions.
4 changes: 4 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -100,3 +100,7 @@ ENV/
# mypy
.mypy_cache/
.idea
*.bak
machine.py
utime.py
_build
20 changes: 20 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# Minimal makefile for Sphinx documentation
#

# You can set these variables from the command line.
SPHINXOPTS =
SPHINXBUILD = python -msphinx
SPHINXPROJ = AdafruitSoundboardLibrary
SOURCEDIR = .
BUILDDIR = _build

# Put it first so that "make" without argument is like "make help".
help:
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

.PHONY: help Makefile

# Catch-all target: route all unknown targets to Sphinx using the new
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
%: Makefile
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
6 changes: 3 additions & 3 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -52,9 +52,9 @@ Then, create an instance of the :class:`~soundboard.Soundboard` class, like this
sound = Soundboard('XB')

I *highly* recommend you also attach the ``RST`` pin on the soundboard to one of the other GPIO pins on the MCU (pin
`X11` in the example). Also, my alternative method of getting the list of files from the board is more stable (in my own
testing) than the method built-in to the soundboard. Also, I like getting the debug output and I turn the volume down to
50% while I'm coding. Doing all this looks like the following:
``X11`` in the example). Also, my alternative method of getting the list of files from the board is more stable (in my
own testing) than the method built-in to the soundboard. Also, I like getting the debug output and I turn the volume
down to 50% while I'm coding. Doing all this looks like the following:

::

Expand Down
3 changes: 0 additions & 3 deletions adafruit_soundboard.py
Original file line number Diff line number Diff line change
Expand Up @@ -20,9 +20,6 @@
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
# THE SOFTWARE.
"""
`adafruit_soundboard`
====================================================
This is a MicroPython library for the Adafruit Sound Boards in UART mode!
This library has been adapted from the library written by Adafruit for Arduino,
Expand Down
6 changes: 5 additions & 1 deletion api.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
.. automodule:: soundboard
=====================
`adafruit_soundboard`
=====================

.. automodule:: adafruit_soundboard
:members:

.. py:data:: SB_BAUD
Expand Down

0 comments on commit f84b792

Please sign in to comment.