From 9f78bf3142f61696eda5c08a1132fc7c0754ebb7 Mon Sep 17 00:00:00 2001 From: Kattni Rembor Date: Fri, 10 Apr 2020 14:02:07 -0400 Subject: [PATCH 1/7] Black formatting and adding setup.py.disabled --- docs/conf.py | 16 ++++++++-------- setup.py.disabled | 2 ++ 2 files changed, 10 insertions(+), 8 deletions(-) create mode 100644 setup.py.disabled diff --git a/docs/conf.py b/docs/conf.py index ead45a6..92e3f76 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -38,18 +38,18 @@ master_doc = "index" # General information about the project. -project = u"Adafruit_ CPython Library" -copyright = u"2017 Scott Shawcroft" -author = u"Scott Shawcroft" +project = "Adafruit_ CPython Library" +copyright = "2017 Scott Shawcroft" +author = "Scott Shawcroft" # The version info for the project you're documenting, acts as replacement for # |version| and |release|, also used in various other places throughout the # built documents. # # The short X.Y version. -version = u"1.0" +version = "1.0" # The full version, including alpha/beta/rc tags. -release = u"1.0" +release = "1.0" # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. @@ -140,7 +140,7 @@ ( master_doc, "Adafruit_CPythonLibrary.tex", - u"Adafruit_CPython Library Documentation", + "Adafruit_CPython Library Documentation", author, "manual", ), @@ -154,7 +154,7 @@ ( master_doc, "Adafruit_CPythonlibrary", - u"Adafruit_ CPython Library Documentation", + "Adafruit_ CPython Library Documentation", [author], 1, ) @@ -169,7 +169,7 @@ ( master_doc, "Adafruit_CPythonLibrary", - u"Adafruit_ CPython Library Documentation", + "Adafruit_ CPython Library Documentation", author, "Adafruit_CPythonLibrary", "One line description of project.", diff --git a/setup.py.disabled b/setup.py.disabled new file mode 100644 index 0000000..5e2a982 --- /dev/null +++ b/setup.py.disabled @@ -0,0 +1,2 @@ +"""This library is not deployed to PyPI. It is either a board-specific helper library or +does not make sense for use on single board computers and Linux.""" From 130f406fed5faf81ba3db92aa360ed700547f4ec Mon Sep 17 00:00:00 2001 From: Kattni Rembor Date: Fri, 10 Apr 2020 14:05:14 -0400 Subject: [PATCH 2/7] Pylint. --- adafruit__cpython.py => adafruit_cpython.py | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) rename adafruit__cpython.py => adafruit_cpython.py (92%) diff --git a/adafruit__cpython.py b/adafruit_cpython.py similarity index 92% rename from adafruit__cpython.py rename to adafruit_cpython.py index 99b51b7..2ea6330 100644 --- a/adafruit__cpython.py +++ b/adafruit_cpython.py @@ -32,15 +32,16 @@ **Hardware:** -.. todo:: Add links to any specific hardware product page(s), or category page(s). Use unordered list & hyperlink rST - inline format: "* `Link Text `_" +.. todo:: Add links to any specific hardware product page(s), or category page(s). Use unordered + list & hyperlink rST inline format: "* `Link Text `_" **Software and Dependencies:** * Adafruit CircuitPython firmware for the supported boards: https://github.com/adafruit/circuitpython/releases -.. todo:: Uncomment or remove the Bus Device and/or the Register library dependencies based on the library's use of either. +.. todo:: Uncomment or remove the Bus Device and/or the Register library dependencies based on the + library's use of either. # * Adafruit's Bus Device library: https://github.com/adafruit/Adafruit_CircuitPython_BusDevice # * Adafruit's Register library: https://github.com/adafruit/Adafruit_CircuitPython_Register From bbe8cba993298493c6d7972bd8a82dae804ef5e9 Mon Sep 17 00:00:00 2001 From: Kattni Rembor Date: Fri, 10 Apr 2020 14:08:21 -0400 Subject: [PATCH 3/7] Update api.rst --- docs/api.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/api.rst b/docs/api.rst index 2d7b2dd..b06e492 100644 --- a/docs/api.rst +++ b/docs/api.rst @@ -4,5 +4,5 @@ .. If your library file(s) are nested in a directory (e.g. /adafruit_foo/foo.py) .. use this format as the module name: "adafruit_foo.foo" -.. automodule:: adafruit__cpython +.. automodule:: adafruit_cpython :members: From 65daae6e2e528edddc87f6c9a20406deeb05391a Mon Sep 17 00:00:00 2001 From: Kattni Rembor Date: Fri, 10 Apr 2020 14:13:26 -0400 Subject: [PATCH 4/7] Sphinx. --- README.rst | 4 ++-- adafruit_cpython.py | 14 ++------------ docs/index.rst | 6 ------ 3 files changed, 4 insertions(+), 20 deletions(-) diff --git a/README.rst b/README.rst index 094578c..ba3140e 100644 --- a/README.rst +++ b/README.rst @@ -13,7 +13,7 @@ Introduction :target: https://github.com/adafruit/Adafruit_CircuitPython_CPython/actions :alt: Build Status -.. todo:: Describe what the library does. +CPython modules made available for CircuitPython. Dependencies ============= @@ -28,7 +28,7 @@ This is easily achieved by downloading Usage Example ============= -.. todo:: Add a quick, simple example. It and other examples should live in the examples folder and be included in docs/examples.rst. +See example in docs/examples.rst. Contributing ============ diff --git a/adafruit_cpython.py b/adafruit_cpython.py index 2ea6330..e81d303 100644 --- a/adafruit_cpython.py +++ b/adafruit_cpython.py @@ -20,31 +20,21 @@ # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN # THE SOFTWARE. """ -`Adafruit__CPython` +`adafruit_cpython` ==================================================== -.. todo:: Describe what the module does +CPython modules for use in CircuitPython. * Author(s): Scott Shawcroft Implementation Notes -------------------- -**Hardware:** - -.. todo:: Add links to any specific hardware product page(s), or category page(s). Use unordered - list & hyperlink rST inline format: "* `Link Text `_" - **Software and Dependencies:** * Adafruit CircuitPython firmware for the supported boards: https://github.com/adafruit/circuitpython/releases -.. todo:: Uncomment or remove the Bus Device and/or the Register library dependencies based on the - library's use of either. - -# * Adafruit's Bus Device library: https://github.com/adafruit/Adafruit_CircuitPython_BusDevice -# * Adafruit's Register library: https://github.com/adafruit/Adafruit_CircuitPython_Register """ # imports diff --git a/docs/index.rst b/docs/index.rst index dc4bc3d..6de1ff3 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -23,15 +23,9 @@ Table of Contents .. toctree:: :caption: Tutorials -.. todo:: Add any Learn guide links here. If there are none, then simply delete this todo and leave - the toctree above for use later. - .. toctree:: :caption: Related Products -.. todo:: Add any product links here. If there are none, then simply delete this todo and leave - the toctree above for use later. - .. toctree:: :caption: Other Links From a5acc0f0e91dffb371f7fcbf1713b3ac886ecf8f Mon Sep 17 00:00:00 2001 From: Kattni Rembor Date: Fri, 10 Apr 2020 14:33:30 -0400 Subject: [PATCH 5/7] Update wording --- setup.py.disabled | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/setup.py.disabled b/setup.py.disabled index 5e2a982..a80b9bf 100644 --- a/setup.py.disabled +++ b/setup.py.disabled @@ -1,2 +1,4 @@ -"""This library is not deployed to PyPI. It is either a board-specific helper library or -does not make sense for use on single board computers and Linux.""" +""" +This library is not deployed to PyPI. It is either a board-specific helper library, or +does not make sense for use on or is incompatible with single board computers and Linux. +""" From 339cb8e6279c97c129a27c8a8c8ff735e57c0d95 Mon Sep 17 00:00:00 2001 From: Kattni Rembor Date: Fri, 10 Apr 2020 14:35:25 -0400 Subject: [PATCH 6/7] Remove stray _ --- docs/conf.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/conf.py b/docs/conf.py index 92e3f76..4790fa7 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -38,7 +38,7 @@ master_doc = "index" # General information about the project. -project = "Adafruit_ CPython Library" +project = "Adafruit CPython Library" copyright = "2017 Scott Shawcroft" author = "Scott Shawcroft" From 1e33665ecff16a9184146169f8e1d811173837aa Mon Sep 17 00:00:00 2001 From: Kattni Rembor Date: Fri, 10 Apr 2020 14:36:20 -0400 Subject: [PATCH 7/7] Remove stray _ --- docs/conf.py | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index 4790fa7..048df01 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -114,7 +114,7 @@ html_favicon = "_static/favicon.ico" # Output file base name for HTML help builder. -htmlhelp_basename = "Adafruit_CpythonLibrarydoc" +htmlhelp_basename = "AdafruitCpythonLibrarydoc" # -- Options for LaTeX output --------------------------------------------- @@ -139,8 +139,8 @@ latex_documents = [ ( master_doc, - "Adafruit_CPythonLibrary.tex", - "Adafruit_CPython Library Documentation", + "AdafruitCPythonLibrary.tex", + "AdafruitCPython Library Documentation", author, "manual", ), @@ -153,8 +153,8 @@ man_pages = [ ( master_doc, - "Adafruit_CPythonlibrary", - "Adafruit_ CPython Library Documentation", + "AdafruitCPythonlibrary", + "Adafruit CPython Library Documentation", [author], 1, ) @@ -168,10 +168,10 @@ texinfo_documents = [ ( master_doc, - "Adafruit_CPythonLibrary", - "Adafruit_ CPython Library Documentation", + "AdafruitCPythonLibrary", + "Adafruit CPython Library Documentation", author, - "Adafruit_CPythonLibrary", + "AdafruitCPythonLibrary", "One line description of project.", "Miscellaneous", ),