From 52c8cab80c97deaa69d957627afb1db188f4c319 Mon Sep 17 00:00:00 2001 From: sommersoft Date: Sat, 3 Mar 2018 17:01:31 -0600 Subject: [PATCH 1/7] renamed example; 1 learn guide needs link update --- examples/{sgp30_test.py => sgp30_simpletest.py} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename examples/{sgp30_test.py => sgp30_simpletest.py} (100%) diff --git a/examples/sgp30_test.py b/examples/sgp30_simpletest.py similarity index 100% rename from examples/sgp30_test.py rename to examples/sgp30_simpletest.py From 05d033d0013caf81ee0f5a8e3addb5be41dcb841 Mon Sep 17 00:00:00 2001 From: sommersoft Date: Sat, 3 Mar 2018 17:16:56 -0600 Subject: [PATCH 2/7] setup docs folder --- docs/_static/favicon.ico | Bin 0 -> 4414 bytes api.rst => docs/api.rst | 0 conf.py => docs/conf.py | 15 ++++++++++--- docs/examples.rst | 8 +++++++ docs/index.rst | 47 +++++++++++++++++++++++++++++++++++++++ 5 files changed, 67 insertions(+), 3 deletions(-) create mode 100644 docs/_static/favicon.ico rename api.rst => docs/api.rst (100%) 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@Kt!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_lTlCrGx2z$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*pRqiK~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?^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 zn9CL}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;+2#5Cj5pp?FEK750S3BgeSDtaE^ zXUM@xoV6yBFKfzvY20V&Lr0yC + +.. toctree:: + :caption: Other Links + + Download + CircuitPython Reference Documentation + CircuitPython Support Forum + Discord Chat + Adafruit Learning System + Adafruit Blog + Adafruit Store + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` From c2c049c1719de63ccfa4a303aaa447a1ed434850 Mon Sep 17 00:00:00 2001 From: sommersoft Date: Sat, 3 Mar 2018 17:20:17 -0600 Subject: [PATCH 3/7] updated .travis & .readthedocs yml --- readthedocs.yml => .readthedocs.yml | 0 .travis.yml | 5 +++-- 2 files changed, 3 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 a2641b4..a744eff 100644 --- a/.travis.yml +++ b/.travis.yml @@ -16,16 +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_sgp30.py - ([[ ! -d "examples" ]] || pylint --disable=missing-docstring,invalid-name examples/*.py) - circuitpython-build-bundles --filename_prefix adafruit-circuitpython-sgp30 --library_location . + - cd docs && sphinx-build -E -W -b html . _build/html From 085ef4d8dd7617d61c10a03f0545a9ee7f7b6800 Mon Sep 17 00:00:00 2001 From: sommersoft Date: Sat, 3 Mar 2018 17:23:06 -0600 Subject: [PATCH 4/7] updated README --- README.rst | 31 +++++++++++++++++++++++-------- 1 file changed, 23 insertions(+), 8 deletions(-) diff --git a/README.rst b/README.rst index df75950..2f9481f 100644 --- a/README.rst +++ b/README.rst @@ -60,14 +60,6 @@ To read from the sensor: print("CO2eq = %d ppm \t TVOC = %d ppb" % (co2eq, tvoc)) -API Reference -============= - -.. toctree:: - :maxdepth: 2 - - api - Contributing ============ @@ -98,3 +90,26 @@ Then run the build: .. code-block:: shell circuitpython-build-bundles --filename_prefix adafruit-circuitpython-sgp30 --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 + +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. \ No newline at end of file From cea69dee89cc5514fb65f7697742387baa8b9fdf Mon Sep 17 00:00:00 2001 From: sommersoft Date: Sat, 3 Mar 2018 17:30:08 -0600 Subject: [PATCH 5/7] updated info docstring --- adafruit_sgp30.py | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/adafruit_sgp30.py b/adafruit_sgp30.py index 62dee01..3e8786c 100644 --- a/adafruit_sgp30.py +++ b/adafruit_sgp30.py @@ -26,6 +26,20 @@ I2C driver for SGP30 Sensirion VoC sensor * Author(s): ladyada + +Implementation Notes +-------------------- + +**Hardware:** + +* Adafruit `SGP30 Air Quality Sensor Breakout - VOC and eCO2 + `_ (Product ID: 3709) + +**Software and Dependencies:** + +* Adafruit CircuitPython firmware for the ESP8622 and M0-based boards: + https://github.com/adafruit/circuitpython/releases +* Adafruit's Bus Device library: https://github.com/adafruit/Adafruit_CircuitPython_BusDevice """ import time from adafruit_bus_device.i2c_device import I2CDevice From ad22b3ba60e9392ce50b47236cdd0fc840c9cadc Mon Sep 17 00:00:00 2001 From: sommersoft Date: Sat, 3 Mar 2018 17:32:21 -0600 Subject: [PATCH 6/7] sphinx fix --- README.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.rst b/README.rst index 2f9481f..147c238 100644 --- a/README.rst +++ b/README.rst @@ -50,7 +50,7 @@ Since we have the I2C bus object, we can now use it to instantiate the SGP30 obj sgp30 = adafruit_sgp30.Adafruit_SGP30(i2c_bus) Reading from the Sensor --------------- +------------------------ To read from the sensor: From 01213f365a42ab49e1823ef5f554f3c5c0174baa Mon Sep 17 00:00:00 2001 From: sommersoft Date: Sat, 3 Mar 2018 17:35:52 -0600 Subject: [PATCH 7/7] pylint fix; return of the whitespace --- adafruit_sgp30.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/adafruit_sgp30.py b/adafruit_sgp30.py index 3e8786c..c7b7731 100644 --- a/adafruit_sgp30.py +++ b/adafruit_sgp30.py @@ -32,7 +32,7 @@ **Hardware:** -* Adafruit `SGP30 Air Quality Sensor Breakout - VOC and eCO2 +* Adafruit `SGP30 Air Quality Sensor Breakout - VOC and eCO2 `_ (Product ID: 3709) **Software and Dependencies:**