From 053a0cd724ce4543c5a3cbd7374cbf5ad5d5a3e0 Mon Sep 17 00:00:00 2001 From: sommersoft Date: Thu, 22 Feb 2018 23:33:03 -0600 Subject: [PATCH 1/8] renamed example --- examples/{main.py => bme280_simpletest.py} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename examples/{main.py => bme280_simpletest.py} (100%) diff --git a/examples/main.py b/examples/bme280_simpletest.py similarity index 100% rename from examples/main.py rename to examples/bme280_simpletest.py From fe724c304ef40eda251faee97d06e5fac7f93f2c Mon Sep 17 00:00:00 2001 From: sommersoft Date: Thu, 22 Feb 2018 23:35:38 -0600 Subject: [PATCH 2/8] setup new docs --- docs/_static/favicon.ico | Bin 0 -> 4414 bytes api.rst => docs/api.rst | 0 conf.py => docs/conf.py | 0 docs/examples.rst | 8 +++++++ docs/index.rst | 47 +++++++++++++++++++++++++++++++++++++++ 5 files changed, 55 insertions(+) create mode 100644 docs/_static/favicon.ico rename api.rst => docs/api.rst (100%) rename conf.py => docs/conf.py (100%) 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 2d3f99bc924ccfa2cf0728653e17395953d6ab42 Mon Sep 17 00:00:00 2001 From: sommersoft Date: Thu, 22 Feb 2018 23:37:43 -0600 Subject: [PATCH 3/8] 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 bad274c..9aeaed9 100644 --- a/.travis.yml +++ b/.travis.yml @@ -16,15 +16,16 @@ deploy: provider: releases api_key: $GITHUB_TOKEN file_glob: true - file: bundles/* + file: $TRAVIS_BUILD_DIR/bundles/* skip_cleanup: true on: tags: true install: - - pip install pylint circuitpython-travis-build-tools + - pip install pylint circuitpython-travis-build-tools Sphinx sphinx-rtd-theme script: - pylint adafruit_bme280.py - ([[ ! -d "examples" ]] || pylint --disable=missing-docstring,invalid-name examples/*.py) - circuitpython-build-bundles --filename_prefix adafruit-circuitpython-bme280 --library_location . + - cd docs && sphinx-build -E -W -b html . _build/html From 225e41bf86295bcc1700a0629dfcd016d5c726e2 Mon Sep 17 00:00:00 2001 From: sommersoft Date: Thu, 22 Feb 2018 23:38:51 -0600 Subject: [PATCH 4/8] updated README --- README.rst | 50 +++++++++++++++++++++++++++++++++++++++++++++----- 1 file changed, 45 insertions(+), 5 deletions(-) diff --git a/README.rst b/README.rst index 51ba518..2f142c4 100644 --- a/README.rst +++ b/README.rst @@ -62,10 +62,50 @@ Contributions are welcome! Please read our `Code of Conduct `_ 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 `_ 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-veml6070 --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 c74a35b80b809c8fc39335e60a3629949d2d7e26 Mon Sep 17 00:00:00 2001 From: sommersoft Date: Thu, 22 Feb 2018 23:41:27 -0600 Subject: [PATCH 5/8] forgot to update conf.py...until now --- docs/conf.py | 15 ++++++++++++--- 1 file changed, 12 insertions(+), 3 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index b7c4e45..ce24724 100644 --- a/docs/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 ------------------------------------------------ @@ -26,7 +26,7 @@ source_suffix = '.rst' # The master toctree document. -master_doc = 'README' +master_doc = 'index' # General information about the project. project = u'Adafruit BME280 Library' @@ -52,7 +52,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. @@ -69,6 +69,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 ---------------------------------------------- @@ -93,6 +96,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 = 'AdafruitBME280Librarydoc' From fb5aa30d54c0fade258ff5242d58ac92ad6d1bea Mon Sep 17 00:00:00 2001 From: sommersoft Date: Thu, 22 Feb 2018 23:44:29 -0600 Subject: [PATCH 6/8] added double backticks to doc string --- adafruit_bme280.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/adafruit_bme280.py b/adafruit_bme280.py index 8f7ba47..d4b18b2 100644 --- a/adafruit_bme280.py +++ b/adafruit_bme280.py @@ -178,8 +178,8 @@ def humidity(self): @property def altitude(self): - """The altitude based on current `pressure` versus the sea level pressure - (`sea_level_pressure`) - which you must enter ahead of time)""" + """The altitude based on current ``pressure`` versus the sea level pressure + (``sea_level_pressure``) - which you must enter ahead of time)""" pressure = self.pressure # in Si units for hPascal return 44330 * (1.0 - math.pow(pressure / self.sea_level_pressure, 0.1903)) From 3d1b9141addf0d55ba9a9f04dd2841895db10d9d Mon Sep 17 00:00:00 2001 From: sommersoft Date: Thu, 22 Feb 2018 23:48:16 -0600 Subject: [PATCH 7/8] expanded title on main docstring; also forgot to turn on Travis...hehe --- adafruit_bme280.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/adafruit_bme280.py b/adafruit_bme280.py index d4b18b2..6c6133f 100644 --- a/adafruit_bme280.py +++ b/adafruit_bme280.py @@ -20,8 +20,8 @@ # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN # THE SOFTWARE. """ -`adafruit_bme280` -==================================================== +`adafruit_bme280` - Adafruit BME680 - Temperature, Humidity, Pressure & Gas Sensor +==================================================================================== CircuitPython driver from BME280 Temperature, Humidity and Barometic Pressure sensor From c9fd02b4a3762eb2524545514c9fabd760a97bed Mon Sep 17 00:00:00 2001 From: sommersoft Date: Thu, 22 Feb 2018 23:50:28 -0600 Subject: [PATCH 8/8] pylint fix --- adafruit_bme280.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/adafruit_bme280.py b/adafruit_bme280.py index 6c6133f..50a76b6 100644 --- a/adafruit_bme280.py +++ b/adafruit_bme280.py @@ -20,7 +20,7 @@ # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN # THE SOFTWARE. """ -`adafruit_bme280` - Adafruit BME680 - Temperature, Humidity, Pressure & Gas Sensor +`adafruit_bme280` - Adafruit BME680 - Temperature, Humidity, Pressure & Gas Sensor ==================================================================================== CircuitPython driver from BME280 Temperature, Humidity and Barometic Pressure sensor