docs

Author: jposada202020

CODE_OF_CONDUCT.md

@@ -48,13 +48,6 @@ Usage Example
 Please see the ``slider_simpletest.py`` example for initial reference
 
 
-Contributing
-============
-
-Contributions are welcome! Please read our `Code of Conduct
-<https://github.com/jposada202020/CircuitPython_slider/blob/main/CODE_OF_CONDUCT.md>`_
-before contributing to help this project stay welcoming.
-
 Documentation
 =============
 

README.rst

@@ -1,3 +1,5 @@
+Slider Library
+===============
 
 .. automodule:: slider
    :members:

README.rst.license

@@ -6,25 +6,24 @@
 
 import os
 import sys
+import datetime
 
 sys.path.insert(0, os.path.abspath(".."))
 
 # -- General configuration ------------------------------------------------
 
-# Add any Sphinx extension module names here, as strings. They can be
-# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
-# ones.
 extensions = [
     "sphinx.ext.autodoc",
     "sphinx.ext.intersphinx",
     "sphinx.ext.napoleon",
-    "sphinx.ext.todo",
+    "sphinx.ext.viewcode",
 ]
 
-# TODO: Please Read!
-# Uncomment the below if you use native CircuitPython modules such as
-# digitalio, micropython and busio. List the modules you use. Without it, the
-# autodoc module docs will fail to generate with a warning.
+intersphinx_mapping = {
+    "python": ("https://docs.python.org/3", None),
+    "CircuitPython": ("https://docs.circuitpython.org/en/latest/", None),
+}
+
 autodoc_mock_imports = [
     "digitalio",
     "vectorio",
@@ -37,27 +36,11 @@
     "adafruit_displayio_layout",
 ]
 
-
-intersphinx_mapping = {
-    "python": ("https://docs.python.org/3.4", None),
-    "adafruit_displayio_layout": (
-        "https://circuitpython.readthedocs.io/projects/displayio-layout/en/latest/",
-        None,
-    ),
-    "CircuitPython": ("https://circuitpython.readthedocs.io/en/latest/", None),
-}
-
-# Show the docstring from both the class and its __init__() method.
 autoclass_content = "both"
-
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ["_templates"]
-
 source_suffix = ".rst"
-
-# The master toctree document.
 master_doc = "index"
-
 # General information about the project.
 project = " CircuitPython slider Library"
 copyright = "2021 Jose David M."
@@ -72,13 +55,8 @@
 # The full version, including alpha/beta/rc tags.
 release = "1.0"
 
-# The language for content autogenerated by Sphinx. Refer to documentation
-# for a list of supported languages.
-#
-# This is also used if you do content translation via gettext catalogs.
-# Usually you set "language" from the command line for these cases.
 language = "en"
-
+autoclass_content = "both"
 # 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
@@ -90,24 +68,11 @@
     "CODE_OF_CONDUCT.md",
 ]
 
-# The reST default role (used for this markup: `text`) to use for all
-# documents.
-#
 default_role = "any"
-
-# If true, '()' will be appended to :func: etc. cross-reference text.
-#
 add_function_parentheses = True
-
-# The name of the Pygments (syntax highlighting) style to use.
 pygments_style = "sphinx"
-
-# 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
-
+todo_emit_warnings = False
 napoleon_numpy_docstring = False
 
 # -- Options for HTML output ----------------------------------------------

docs/api.rst

@@ -5,4 +5,4 @@ Ensure your device works with this simple test.
 
 .. literalinclude:: ../examples/slider_simpletest.py
     :caption: examples/slider_simpletest.py
-    :linenos:
+    :lines: 9-

docs/api.rst.license

@@ -307,10 +307,8 @@ def when_selected(self, touch_point):
         """
 
         if touch_point[0] <= self.x + self._knob_width:
-            print("maayor", touch_point[0])
             touch_x = touch_point[0] - self.x
         else:
-            print("menor", touch_point[0])
             touch_x = touch_point[0] - self.x - self._knob_width
 
         touch_y = touch_point[1] - self.y