Merge pull request #6 from tannewt/auto_build_sphinx

Rework doc organization

Author: kattni

readthedocs.yml renamed to .readthedocs.yml

@@ -22,9 +22,10 @@ deploy:
     tags: true
 
 install:
-  - pip install pylint circuitpython-build-tools
+  - pip install pylint circuitpython-build-tools Sphinx sphinx-rtd-theme
 
 script:
   - pylint adafruit_pcf8523.py
   - ([[ ! -d "examples" ]] || pylint --disable=missing-docstring,invalid-name examples/*.py)
   - circuitpython-build-bundles --filename_prefix adafruit-circuitpython-pcf8523 --library_location .
+  - cd docs && sphinx-build -E -W -b html . _build/html

.travis.yml

@@ -6,9 +6,13 @@ Introduction to Adafruit's PCF8523 Real Time Clock (RTC) Library
     :target: https://circuitpython.readthedocs.io/projects/pcf8523/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
+
+.. image:: https://travis-ci.org/adafruit/Adafruit_CircuitPython_PCF8523.svg?branch=master
+    :target: https://travis-ci.org/adafruit/Adafruit_CircuitPython_PCF8523
+    :alt: Build Status
 
 This is a great battery-backed real time clock (RTC) that allows your
 microcontroller project to keep track of time even if it is reprogrammed,
@@ -23,7 +27,8 @@ temperature compensated alternative, please check out the
 If you need a DS1307 for compatibility reasons, check out our
 `DS1307 RTC breakout <https://www.adafruit.com/products/3296>`_.
 
-.. image:: 3295-00.jpg
+.. image:: _static/3295-00.jpg
+    :alt: PCF8523 Breakout Board
 
 Dependencies
 =============
@@ -76,15 +81,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`.
+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``.
 
 .. code:: python
 
@@ -95,7 +100,7 @@ attribute and access the standard attributes of a struct_time such as `tm_year`,
 Alarm
 -----
 
-To set the time, you need to set ``alarm`` to a tuple with a `time.struct_time`
+To set the time, you need to set `alarm` to a tuple with a `time.struct_time`
 object and string representing the frequency such as "hourly":
 
 .. code:: python
@@ -110,11 +115,3 @@ After the RTC is set, you retrieve the alarm status by reading the
     if rtc.alarm_status:
         print("wake up!")
         rtc.alarm_status = False
-
-API Reference
-=============
-
-.. toctree::
-   :maxdepth: 2
-
-   api

README.rst

@@ -18,7 +18,7 @@
 #
 import os
 import sys
-sys.path.insert(0, os.path.abspath('.'))
+sys.path.insert(0, os.path.abspath('..'))
 
 # -- General configuration ------------------------------------------------
 
@@ -32,10 +32,14 @@
 extensions = [
     'sphinx.ext.autodoc',
     'sphinx.ext.todo',
-    'sphinx.ext.viewcode',
     'sphinx.ext.intersphinx'
 ]
 
+# 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.
+autodoc_mock_imports = ["adafruit_bus_device", "adafruit_register"]
+
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
 
@@ -50,7 +54,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 PCF8523 RTC Library'
@@ -85,7 +89,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.
@@ -116,8 +120,10 @@
 # keep_warnings = False
 
 # If true, `todo` and `todoList` produce output, else they produce nothing.
-todo_include_todos = True
+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 ----------------------------------------------
 
@@ -160,11 +166,10 @@
 #
 # html_logo = None
 
-# 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
+# The name of an image file (within the static path) to use as favicon of the
+# docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
 # pixels large.
-#
-# html_favicon = None
+html_favicon = '_static/favicon.ico'
 
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,

3295-00.jpg renamed to docs/_static/3295-00.jpg

@@ -0,0 +1,6 @@
+Demo
+----
+
+.. literalinclude:: ../examples/demo.py
+    :caption: examples/demo.py
+    :linenos:

docs/_static/favicon.ico

@@ -0,0 +1,51 @@
+.. include:: ../README.rst
+
+Table of Contents
+=================
+
+.. toctree::
+    :maxdepth: 4
+    :hidden:
+
+    self
+
+.. toctree::
+    :caption: Examples
+
+    examples
+
+.. toctree::
+    :caption: API Reference
+    :maxdepth: 3
+
+    api
+
+.. toctree::
+    :caption: Tutorials
+
+    Adafruit PCF8523 Real Time Clock <https://learn.adafruit.com/adafruit-pcf8523-real-time-clock?view=all>
+    Adafruit Adalogger FeatherWing <https://learn.adafruit.com/adafruit-adalogger-featherwing?view=all>
+
+.. toctree::
+    :caption: Related Products
+
+    Adafruit PCF8523 Real Time Clock Breakout <https://www.adafruit.com/product/3295>
+    Adafruit Adalogger FeatherWing - RTC + SD <https://www.adafruit.com/product/2922>
+
+.. toctree::
+    :caption: Other Links
+
+    Download <https://github.com/adafruit/Adafruit_CircuitPython_PCF8523/releases/latest>
+    CircuitPython Reference Documentation <https://circuitpython.readthedocs.io>
+    CircuitPython Support Forum <https://forums.adafruit.com/viewforum.php?f=60>
+    Discord Chat <https://adafru.it/discord>
+    Adafruit Learning System <https://learn.adafruit.com>
+    Adafruit Blog <https://blog.adafruit.com>
+    Adafruit Store <https://www.adafruit.com>
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`