Merge pull request #6 from sommersoft/new_docs

Improve Ref Docs

Author: kattni

readthedocs.yml renamed to .readthedocs.yml

@@ -1,2 +1,4 @@
+python:
+    version: 3
 requirements_file: requirements.txt
 

.travis.yml

@@ -16,15 +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_ds3231.py
   - ([[ ! -d "examples" ]] || pylint --disable=missing-docstring,invalid-name examples/*.py)
   - circuitpython-build-bundles --filename_prefix adafruit-circuitpython-ds3231 --library_location .
+  - cd docs && sphinx-build -E -W -b html . _build/html

CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at [email protected]. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

README.rst

@@ -1,13 +1,13 @@
-Introduction
+Introduction
 ============
 
 .. image:: https://readthedocs.org/projects/adafruit-micropython-ds3231/badge/?version=latest
     :target: https://circuitpython.readthedocs.io/projects/ds3231/en/latest/
     :alt: Documentation Status
 
-.. image :: https://badges.gitter.im/adafruit/circuitpython.svg
-    :target: https://gitter.im/adafruit/circuitpython?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge
-    :alt: Gitter
+.. image :: https://img.shields.io/discord/327254708534116352.svg
+    :target: https://discord.gg/nBQh6qu
+    :alt: Discord
 
 The datasheet for the DS3231 explains that this part is an
 "Extremely Accurate I²C-Integrated RTC/TCXO/Crystal". And,
@@ -33,16 +33,19 @@ timekeeping, even when main power is lost. Great for
 datalogging and clocks, or anything where you need to
 really know the time.
 
-.. image:: 3013-01.jpg
+.. image:: ../docs/_static/3013-01.jpg
 
 Dependencies
 =============
+This driver depends on:
 
-This driver depends on the `Register <https://github.com/adafruit/Adafruit_CircuitPython_Register>`_
-and `Bus Device <https://github.com/adafruit/Adafruit_CircuitPython_BusDevice>`_
-libraries. Please ensure they are also available on the CircuitPython filesystem.
+* `Adafruit CircuitPython <https://github.com/adafruit/circuitpython>`_
+* `Bus Device <https://github.com/adafruit/Adafruit_CircuitPython_BusDevice>`_
+* `Register <https://github.com/adafruit/Adafruit_CircuitPython_Register>`_
+
+Please ensure all dependencies are available on the CircuitPython filesystem.
 This is easily achieved by downloading
-`a library and driver bundle <https://github.com/adafruit/Adafruit_CircuitPython_Bundle>`_.
+`the Adafruit library and driver bundle <https://github.com/adafruit/Adafruit_CircuitPython_Bundle>`_.
 
 Usage Notes
 ===========
@@ -59,16 +62,16 @@ Of course, you must import the library to use it:
     import time
 
 All the Adafruit RTC libraries take an instantiated and active I2C object
-(from the `busio` library) as an argument to their constructor. The way to
+(from the ``busio`` library) as an argument to their constructor. The way to
 create an I2C object depends on the board you are using. For boards with labeled
 SCL and SDA pins, you can:
 
 .. code:: python
 
     from board import *
 
-You can also use pins defined by the onboard `microcontroller` through the
-`microcontroller.pin` module.
+You can also use pins defined by the onboard ``microcontroller`` through the
+``microcontroller.pin`` module.
 
 Now, to initialize the I2C bus:
 
@@ -86,15 +89,15 @@ the RTC object:
 Date and time
 -------------
 
-To set the time, you need to set ``datetime`` to a `time.struct_time` object:
+To set the time, you need to set ``datetime`` to a ``time.struct_time`` object:
 
 .. code:: python
 
     rtc.datetime = time.struct_time((2017,1,9,15,6,0,0,9,-1))
 
 After the RTC is set, you retrieve the time by reading the ``datetime``
-attribute and access the standard attributes of a struct_time such as `tm_year`,
-`tm_hour` and `tm_min`.
+attribute and access the standard attributes of a struct_time such as ``tm_year``,
+``tm_hour`` and ``tm_min``.
 
 .. code:: python
 
@@ -106,14 +109,14 @@ Alarm
 -----
 
 To set the time, you need to set ``alarm1`` or ``alarm2`` to a tuple with a
-`time.struct_time` object and string representing the frequency such as "hourly":
+``time.struct_time`` object and string representing the frequency such as "hourly":
 
 .. code:: python
 
     rtc.alarm1 = (time.struct_time((2017,1,9,15,6,0,0,9,-1)), "daily")
 
 After the RTC is set, you retrieve the alarm status by reading the corresponding
-`alarm1_status` or `alarm2_status` attributes. Once True, set it back to False
+``alarm1_status`` or ``alarm2_status`` attributes. Once True, set it back to False
 to reset.
 
 .. code:: python
@@ -122,10 +125,56 @@ to reset.
         print("wake up!")
         rtc.alarm1_status = False
 
-API Reference
-=============
+Contributing
+============
+
+Contributions are welcome! Please read our `Code of Conduct
+<https://github.com/adafruit/Adafruit_CircuitPython_DS3231/blob/master/CODE_OF_CONDUCT.md>`_
+before contributing to help this project stay welcoming.
+
+Building locally
+================
+
+To build this library locally you'll need to install the
+`circuitpython-build-tools <https://github.com/adafruit/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-ds3231 --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
 
-.. toctree::
-   :maxdepth: 2
+    cd docs
+    sphinx-build -E -W -b html . _build/html
 
-   api
+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.

adafruit_ds3231.py

@@ -34,15 +34,17 @@
 **Hardware:**
 
 * Adafruit `DS3231 Precision RTC FeatherWing <https://www.adafruit.com/products/3028>`_
-(Product ID: 3028)
+  (Product ID: 3028)
+
 * Adafruit `DS3231 RTC breakout <https://www.adafruit.com/products/3013>`_ (Product ID: 3013)
 * Adafruit `ChronoDot - Ultra-precise Real Time Clock -
-v2.1 <https://www.adafruit.com/products/255>`_ (Product ID: 3013)
+  v2.1 <https://www.adafruit.com/products/255>`_ (Product ID: 3013)
 
 **Software and Dependencies:**
 
 * Adafruit CircuitPython firmware for the ESP8622 and M0-based boards:
-https://github.com/adafruit/circuitpython/releases
+  https://github.com/adafruit/circuitpython/releases
+
 * Adafruit's Register library: https://github.com/adafruit/Adafruit_CircuitPython_Register
 * Adafruit's Bus Device library: https://github.com/adafruit/Adafruit_CircuitPython_BusDevice
 

3013-01.jpg renamed to docs/_static/3013-01.jpg

@@ -18,7 +18,7 @@
 #
 import os
 import sys
-sys.path.insert(0, os.path.abspath('.'))
+sys.path.insert(0, os.path.abspath('..'))
 
 # -- General configuration ------------------------------------------------
 
@@ -55,7 +55,7 @@
 # source_encoding = 'utf-8-sig'
 
 # The master toctree document.
-master_doc = 'README'
+master_doc = 'index'
 
 # General information about the project.
 project = u'Adafruit\'s DS3231 RTC Library'
@@ -90,7 +90,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.
@@ -99,7 +99,7 @@
 
 # If true, '()' will be appended to :func: etc. cross-reference text.
 #
-# add_function_parentheses = True
+add_function_parentheses = True
 
 # If true, the current module name will be prepended to all description
 # unit titles (such as .. function::).
@@ -123,6 +123,9 @@
 # If true, `todo` and `todoList` produce output, else they produce nothing.
 todo_include_todos = True
 
+# If this is True, todo emits a warning for each TODO entries. The default is False.
+todo_emit_warnings = True
+
 
 # -- Options for HTML output ----------------------------------------------
 
@@ -176,6 +179,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'
+
 # Add any extra paths that contain custom files (such as robots.txt or
 # .htaccess) here, relative to this directory. These files are copied
 # directly to the root of the documentation.
@@ -254,7 +263,7 @@
 # html_search_scorer = 'scorer.js'
 
 # Output file base name for HTML help builder.
-# htmlhelp_basename = 'AdafruitsDS3231RTCLibrarydoc'
+htmlhelp_basename = 'AdafruitsDS3231RTCLibrarydoc'
 
 # -- Options for LaTeX output ---------------------------------------------
 

docs/_static/favicon.ico

@@ -0,0 +1,8 @@
+Simple test
+------------
+
+Ensure your device works with this simple test.
+
+.. literalinclude:: ../examples/ds3231_simpletest.py
+    :caption: examples/ds3231_simpletest.py
+    :linenos: