From d5541a0245779e2921e9aaad75c2f4e2bc09e1d7 Mon Sep 17 00:00:00 2001
From: sommersoft <sommersoft@gmail.com>
Date: Tue, 6 Mar 2018 20:20:21 -0600
Subject: [PATCH 1/4] setup docs folder

---
 docs/_static/favicon.ico | Bin 0 -> 4414 bytes
 api.rst => docs/api.rst  |   4 ++++
 conf.py => docs/conf.py  |  15 ++++++++++---
 docs/examples.rst        |  12 +++++++++++
 docs/index.rst           |  45 +++++++++++++++++++++++++++++++++++++++
 5 files changed, 73 insertions(+), 3 deletions(-)
 create mode 100644 docs/_static/favicon.ico
 rename api.rst => docs/api.rst (70%)
 rename conf.py => docs/conf.py (90%)
 create mode 100644 docs/examples.rst
 create mode 100644 docs/index.rst

diff --git a/docs/_static/favicon.ico b/docs/_static/favicon.ico
new file mode 100644
index 0000000000000000000000000000000000000000..5aca98376a1f7e593ebd9cf41a808512c2135635
GIT binary patch
literal 4414
zcmd^BX;4#F6n=SG-XmlONeGrD5E6J{RVh+e928U#MG!$jWvO+UsvWh`x&VqGNx*en
zx=qox7Dqv{kPwo%fZC$dDwVpRtz{HzTkSs8QhG0)%Y=-3@K<l<<eYo%Ip25pcQK3x
ze*XR#{Ku3+4D-S;ObG<IuyH`3e-Mg-fw5M5;xdhtq1wvFCFMAVF9f*3gMj@w2ttJW
zR;Q9>t!4ag|JcIo?$-F|?bXVS9UDUyev>MVZQ(H8K4#;BQW-t2CPorj8^KJrMX}QK
zp+e<;4ldpXz~=)2GxNy811&)gt-}Q*yVQpsxr@VMoA##{)$1~=bZ1MmjeFw?uT(`8
z^g=09<=zW%r%buwN%iHtuKSg|+r7HkT0PYN*_u9k1;^Ss-Z!RBfJ?Un4w(awqp2b3
z%+myoFis_lTlCrGx<dCu7t-9+rxBh;UU30&SA@;~J%BAW6-y3VPQI0H*e<WJX?<&t
zpDCGaRC}9kmEu$Oa}}v(HUDNO$nP=Esno$f#`34=>2z$0BQdh+7?!JK#9K9@Z!VrG
zNj6gK5r(b4?YDOLw|DPRoN7bdP{(>GEG41YcN~4r_SUHU2hgVtUwZG@s%edC;k7Sn
zC)RvEnlq~raE2mY2ko64^m1KQL}3riixh?#J{o)IT+K-RdHae2eRX91-+g!y`8^>#
z-zI0ir>P%Xon)!@xp-BK2bDYUB9k613NRrY6%lVjbFcQc*pR<Snem;7;nfmNCKyIb
zV;aJU1T)2sGslQt)(vOJ>qiK~8xtkNPLxt}e?&QsTB}^!39t_%Qb)~Ukn0O%iC;zt
z<&A-y;3h++)>c1br`5VFM~5(83!HKx$L+my8sW_c#@x*|*vB1yU)_dt3vH;2hqPWx
zAl^6@?ipx&U7pf`a*>Yq6C85nb+B=Fnn+(id$W#WB^uHAcZVG`qg;rWB}ubvi(Y>D
z$ei>REw$#xp0SHAd^|1hq&9HJ=jKK8^zTH~nk)G?yUcmTh9vUM6Y0LMw4(gYVY$D$
zGl&WY&H<)BbJ&3sYbKjx1j^=3-0Q#f^}(aP1?8^`&FUWMp|rmtpK)bLQ1Zo<!81CG
zsjS;turE*y)L_5#=nFEMw(z?yPo#ny)`e!?S}ITO@FMuNfbfy`0m)z$tyIjs2G?*N
zm0s77scmR0&Tia2X6`M7FLCoao*`XmhUYUcEaS*nV(~F>?^s4jqK=Lfg*9&geMGVQ
z#^-*!V`fG@;H&{M9S8%+;|h&Qrxym0Ar>WT4BCVLR8cGXF=JmEYN(sNT(9vl+S|%g
z8r7nXQ(95i^`=+XHo|){$vf2$?=`F$^&wFlYXyXg$B{a>$-Fp+V}+D;9k=~Xl~?C4
zAB-;RKXdUzBJE{V&d&%R>aEfFe;vxqI$0@hwVM}gFeQR@j}a>DDxR+n+-*6|_)k%%
z*mSpDV|=5I9!&VC&9tD%fcVygWZV!iIo2qFtm#!*(s|@ZT33*Ad;+<|3^+yrp*;oH
zBSYLV(H1zTU?2WjrCQoQW)Z>J2a=dTriuvezBmu16`tM2fm7Q@d4^iqII-xFpwHGI
zn<z;!)X&^$x2>9CL}QE*1vdj2PX{PIuqOe5dracsciH6OlAZATvE8rj6ykqdIjal2
z0S0S~PwHb-5?OQ-tU-^KTG@XNrEVSvo|HIP?H;7ZhYeZkhSqh-{reE!5di;1zk$#Y
zCe7rOnlzFYJ6Z#Hm$GoidKB=2HBCwm`BbZVeZY4ukmG%1uz7p2URs6c9j-Gjj^oQV
zsdDb3@k2e`C$1I5ML5U0Qs0C1GAp^?!*`=|Nm(vWz3j*j*8ucum2;r0^-6Aca=Gv)
zc%}&;!+_*S2tlnnJnz0EKeRmw-Y!@9ob!XQBwiv}^u9MkaXHvM=!<3YX;+<jQC-0u
zTIZbaVttaB6kJ{4pU_!C&AAKa__r1E)EgUBa|f(F;*S;tT3qBCkWS#t_EhP}R`~rw
z9NLJ2e~Lzrx8(XwI1ASt`Jsk!0Dv_B#D$8G#km5<s|nBRdqYExwbbm6*U|$TNrH8y
zes7^cDe`NEZz0&`?=IH6K=-gzc&Dl9G`c0gUHr*vMcVa6fm7OTNB7$P{Nem1lhJS%
z`XF~PHRpRb2Klh}^uutU$44XStaq0Or(RmAO#3>2#5Cj5pp?FEK750S3BgeSDtaE^
zXUM@xoV6yBFKfzvY20V&Lr0yC<Oi6z3^xtH5Ih5ptD$TF0Pg}75Ykn!|9k$w9UDH)

literal 0
HcmV?d00001

diff --git a/api.rst b/docs/api.rst
similarity index 70%
rename from api.rst
rename to docs/api.rst
index e1bb9ff..f435b9c 100644
--- a/api.rst
+++ b/docs/api.rst
@@ -3,3 +3,7 @@
 
 .. automodule:: adafruit_waveform.sine
    :members:
+
+.. automodule:: adafruit_waveform.square
+   :members:
+
diff --git a/conf.py b/docs/conf.py
similarity index 90%
rename from conf.py
rename to docs/conf.py
index ec4af01..6036375 100644
--- a/conf.py
+++ b/docs/conf.py
@@ -2,7 +2,7 @@
 
 import os
 import sys
-sys.path.insert(0, os.path.abspath('.'))
+sys.path.insert(0, os.path.abspath('..'))
 
 # -- General configuration ------------------------------------------------
 
@@ -23,7 +23,7 @@
 source_suffix = '.rst'
 
 # The master toctree document.
-master_doc = 'README'
+master_doc = 'index'
 
 # General information about the project.
 project = u'Adafruit WAVEFORM Library'
@@ -49,7 +49,7 @@
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
 # This patterns also effect to html_static_path and html_extra_path
-exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store', '.env', 'CODE_OF_CONDUCT.md']
 
 # The reST default role (used for this markup: `text`) to use for all
 # documents.
@@ -66,6 +66,9 @@
 # If true, `todo` and `todoList` produce output, else they produce nothing.
 todo_include_todos = False
 
+# If this is True, todo emits a warning for each TODO entries. The default is False.
+todo_emit_warnings = True
+
 
 # -- Options for HTML output ----------------------------------------------
 
@@ -90,6 +93,12 @@
 # so a file named "default.css" will overwrite the builtin "default.css".
 html_static_path = ['_static']
 
+# The name of an image file (relative to this directory) to use as a favicon of
+# the docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
+# pixels large.
+#
+html_favicon = '_static/favicon.ico'
+
 # Output file base name for HTML help builder.
 htmlhelp_basename = 'AdafruitWAVEFORMLibrarydoc'
 
diff --git a/docs/examples.rst b/docs/examples.rst
new file mode 100644
index 0000000..fafe82e
--- /dev/null
+++ b/docs/examples.rst
@@ -0,0 +1,12 @@
+Simple tests
+-------------
+
+Ensure your device works with these simple tests.
+
+.. literalinclude:: ../examples/sine_demo.py
+    :caption: examples/sine_demo.py
+    :linenos:
+
+.. literalinclude:: ../examples/square_demo.py
+    :caption: examples/square_demo.py
+    :linenos:
\ No newline at end of file
diff --git a/docs/index.rst b/docs/index.rst
new file mode 100644
index 0000000..05e405d
--- /dev/null
+++ b/docs/index.rst
@@ -0,0 +1,45 @@
+.. include:: ../README.rst
+
+Table of Contents
+=================
+
+.. toctree::
+    :maxdepth: 4
+    :hidden:
+
+    self
+
+.. toctree::
+    :caption: Examples
+
+    examples
+
+.. toctree::
+    :caption: API Reference
+    :maxdepth: 3
+
+    api
+
+.. toctree::
+    :caption: Tutorials
+
+.. toctree::
+    :caption: Related Products
+
+.. toctree::
+    :caption: Other Links
+
+    Download <https://github.com/adafruit/Adafruit_CircuitPython_Waveform/releases/latest>
+    CircuitPython Reference Documentation <https://circuitpython.readthedocs.io>
+    CircuitPython Support Forum <https://forums.adafruit.com/viewforum.php?f=60>
+    Discord Chat <https://adafru.it/discord>
+    Adafruit Learning System <https://learn.adafruit.com>
+    Adafruit Blog <https://blog.adafruit.com>
+    Adafruit Store <https://www.adafruit.com>
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`

From cde96ba150b106dc04933f88484207fc670d3543 Mon Sep 17 00:00:00 2001
From: sommersoft <sommersoft@gmail.com>
Date: Tue, 6 Mar 2018 20:21:44 -0600
Subject: [PATCH 2/4] updated .travis & .readthedocs yml

---
 readthedocs.yml => .readthedocs.yml | 0
 .travis.yml                         | 6 ++++--
 2 files changed, 4 insertions(+), 2 deletions(-)
 rename readthedocs.yml => .readthedocs.yml (100%)

diff --git a/readthedocs.yml b/.readthedocs.yml
similarity index 100%
rename from readthedocs.yml
rename to .readthedocs.yml
diff --git a/.travis.yml b/.travis.yml
index 245095f..3d2fcf8 100644
--- a/.travis.yml
+++ b/.travis.yml
@@ -16,15 +16,17 @@ deploy:
   provider: releases
   api_key: $GITHUB_TOKEN
   file_glob: true
-  file: bundles/*
+  file: $TRAVIS_BUILD_DIR/bundles/*
   skip_cleanup: true
+  overwrite: true
   on:
     tags: true
 
 install:
-  - pip install pylint circuitpython-build-tools
+  - pip install pylint circuitpython-build-tools Sphinx sphinx-rtd-theme
 
 script:
   - pylint adafruit_waveform/*.py
   - ([[ ! -d "examples" ]] || pylint --disable=missing-docstring,invalid-name examples/*.py)
   - circuitpython-build-bundles --filename_prefix adafruit-circuitpython-waveform --library_location .
+  - cd docs && sphinx-build -E -W -b html . _build/html
\ No newline at end of file

From 0b3a939ea955c1089282a23bd30732ca76268f5e Mon Sep 17 00:00:00 2001
From: sommersoft <sommersoft@gmail.com>
Date: Tue, 6 Mar 2018 20:23:55 -0600
Subject: [PATCH 3/4] updated README

---
 README.rst | 60 ++++++++++++++++++++++++++++++++++++++++++++++--------
 1 file changed, 52 insertions(+), 8 deletions(-)

diff --git a/README.rst b/README.rst
index 9c1c8ac..d62a85e 100644
--- a/README.rst
+++ b/README.rst
@@ -6,9 +6,13 @@ Introduction
     :target: https://circuitpython.readthedocs.io/projects/waveform/en/latest/
     :alt: Documentation Status
 
-.. image :: https://badges.gitter.im/adafruit/circuitpython.svg
-    :target: https://gitter.im/adafruit/circuitpython?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge
-    :alt: Gitter
+.. image :: https://img.shields.io/discord/327254708534116352.svg
+    :target: https://discord.gg/nBQh6qu
+    :alt: Discord
+
+.. image:: https://travis-ci.org/adafruit/Adafruit_CircuitPython_Waveform.svg?branch=master
+    :target: https://travis-ci.org/adafruit/Adafruit_CircuitPython_Waveform
+    :alt: Build Status
 
 This library generates simple waveforms that can be used to generate different
 type of audio signals.
@@ -40,10 +44,50 @@ Contributions are welcome! Please read our `Code of Conduct
 <https://github.com/adafruit/Adafruit_CircuitPython_waveform/blob/master/CODE_OF_CONDUCT.md>`_
 before contributing to help this project stay welcoming.
 
-API Reference
-=============
+Building locally
+================
+
+To build this library locally you'll need to install the
+`circuitpython-build-tools <https://github.com/adafruit/circuitpython-build-tools>`_ package.
+
+.. code-block:: shell
+
+    python3 -m venv .env
+    source .env/bin/activate
+    pip install circuitpython-build-tools
+
+Once installed, make sure you are in the virtual environment:
+
+.. code-block:: shell
+
+    source .env/bin/activate
+
+Then run the build:
+
+.. code-block:: shell
+
+    circuitpython-build-bundles --filename_prefix adafruit-circuitpython-waveform --library_location .
+
+Sphinx documentation
+-----------------------
+
+Sphinx is used to build the documentation based on rST files and comments in the code. First,
+install dependencies (feel free to reuse the virtual environment from above):
+
+.. code-block:: shell
+
+    python3 -m venv .env
+    source .env/bin/activate
+    pip install Sphinx sphinx-rtd-theme
+
+Now, once you have the virtual environment activated:
+
+.. code-block:: shell
+
+    cd docs
+    sphinx-build -E -W -b html . _build/html
 
-.. toctree::
-   :maxdepth: 2
+This will output the documentation to ``docs/_build/html``. Open the index.html in your browser to
+view them. It will also (due to -W) error out on any warning like Travis will. This is a good way to
+locally verify it will pass.
 
-   api

From 81a0a1fbcc555ca736b3f6d1965ca468078d0f50 Mon Sep 17 00:00:00 2001
From: sommersoft <sommersoft@gmail.com>
Date: Tue, 6 Mar 2018 20:26:17 -0600
Subject: [PATCH 4/4] updated title & info docstrings

---
 adafruit_waveform/sine.py   | 5 +++--
 adafruit_waveform/square.py | 5 +++--
 2 files changed, 6 insertions(+), 4 deletions(-)

diff --git a/adafruit_waveform/sine.py b/adafruit_waveform/sine.py
index 8ca0911..a0d73bc 100644
--- a/adafruit_waveform/sine.py
+++ b/adafruit_waveform/sine.py
@@ -20,10 +20,11 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 # THE SOFTWARE.
 """
-`adafruit_waveform`
+`adafruit_waveform.sine`
 ====================================================
 
-TODO(description)
+This library generates sine waveforms that can be used to generate
+sine audio signals.
 
 * Author(s): Scott Shawcroft
 """
diff --git a/adafruit_waveform/square.py b/adafruit_waveform/square.py
index 6384cf1..42b3639 100644
--- a/adafruit_waveform/square.py
+++ b/adafruit_waveform/square.py
@@ -20,10 +20,11 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 # THE SOFTWARE.
 """
-`adafruit_waveform`
+`adafruit_waveform.square`
 ====================================================
 
-TODO(description)
+This library generates squard waveforms that can be used to generate
+squard audio signals.
 
 * Author(s): Scott Shawcroft, BrentRu
 """