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 similarity index 73% rename from adafruit__cpython.py rename to adafruit_cpython.py index 99b51b7..e81d303 100644 --- a/adafruit__cpython.py +++ b/adafruit_cpython.py @@ -20,30 +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/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: diff --git a/docs/conf.py b/docs/conf.py index ead45a6..048df01 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. @@ -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", - u"Adafruit_CPython Library Documentation", + "AdafruitCPythonLibrary.tex", + "AdafruitCPython Library Documentation", author, "manual", ), @@ -153,8 +153,8 @@ man_pages = [ ( master_doc, - "Adafruit_CPythonlibrary", - u"Adafruit_ CPython Library Documentation", + "AdafruitCPythonlibrary", + "Adafruit CPython Library Documentation", [author], 1, ) @@ -168,10 +168,10 @@ texinfo_documents = [ ( master_doc, - "Adafruit_CPythonLibrary", - u"Adafruit_ CPython Library Documentation", + "AdafruitCPythonLibrary", + "Adafruit CPython Library Documentation", author, - "Adafruit_CPythonLibrary", + "AdafruitCPythonLibrary", "One line description of project.", "Miscellaneous", ), 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 diff --git a/setup.py.disabled b/setup.py.disabled new file mode 100644 index 0000000..a80b9bf --- /dev/null +++ b/setup.py.disabled @@ -0,0 +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 or is incompatible with single board computers and Linux. +"""