From 787e19388253f537969a8da7f629ecd002b526ba Mon Sep 17 00:00:00 2001 From: James Bowman Date: Wed, 10 Feb 2021 06:50:23 -0800 Subject: [PATCH] Clean up --- python/docs/conf.py | 7 ++++--- python/docs/index.rst | 29 +++++++++-------------------- 2 files changed, 13 insertions(+), 23 deletions(-) diff --git a/python/docs/conf.py b/python/docs/conf.py index 4bebeee..ee85eda 100644 --- a/python/docs/conf.py +++ b/python/docs/conf.py @@ -17,8 +17,8 @@ sys.path.insert(0, os.path.abspath('..')) # -- Project information ----------------------------------------------------- project = 'i2cdriver' -copyright = '2020, Excamera Labs' -author = 'Excamera Labs' +copyright = '2021, Excamera Labs' +author = 'James Bowman' # -- General configuration --------------------------------------------------- @@ -27,6 +27,7 @@ author = 'Excamera Labs' # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. extensions = [ + "sphinx_rtd_theme", "sphinx.ext.autodoc", "sphinx.ext.intersphinx" ] @@ -47,7 +48,7 @@ exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. # -html_theme = 'alabaster' +html_theme = 'sphinx_rtd_theme' # 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, diff --git a/python/docs/index.rst b/python/docs/index.rst index 067a176..d6921b6 100644 --- a/python/docs/index.rst +++ b/python/docs/index.rst @@ -1,31 +1,20 @@ -.. i2cdriver documentation master file, created by - sphinx-quickstart on Thu Jan 16 10:21:28 2020. - You can adapt this file completely to your liking, but it should at least - contain the root `toctree` directive. +i2cdriver +========= -Excamera I2CDriver Python API -============================= - - -zxxx +I²CDriver is an easy-to-use, open source tool for controlling I²C devices over USB. +It works with Windows, Mac, and Linux, and has a built-in color screen +that shows a live "dashboard" of all the I²C activity. .. toctree:: :maxdepth: 2 + :caption: Contents: -xxcc - -Official packages are available on PyPI. - -https://pypi.org/project/i2cdriver/ - - -The main page for I2CDriver includes the complete User Guide: - -https://i2cdriver.com +The main page for I²CDriver includes the complete User Guide: +https://i2cdriver.com/i2cdriver.pdf System Requirements -------------------- +=================== Because it is a pure Python module, ``i2cdriver`` can run on any system supported by ``pyserial``. This includes: