mirrors
/
i2cdriver
mirror of https://github.com/jamesbowman/i2cdriver.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Clean up

This commit is contained in:
James Bowman 2021-02-10 06:50:23 -08:00
parent e927bc4ceb
commit 787e193882
2 changed files with 13 additions and 23 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
python/docs/conf.py
View File

@ -17,8 +17,8 @@ sys.path.insert(0, os.path.abspath('..'))
# -- Project information ----------------------------------------------------- # -- Project information -----------------------------------------------------
project = 'i2cdriver' project = 'i2cdriver'
copyright = '2020, Excamera Labs' copyright = '2021, Excamera Labs'
author = 'Excamera Labs' author = 'James Bowman'
# -- General configuration --------------------------------------------------- # -- General configuration ---------------------------------------------------
@ -27,6 +27,7 @@ author = 'Excamera Labs'
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones. # ones.
extensions = [ extensions = [
"sphinx_rtd_theme",
"sphinx.ext.autodoc", "sphinx.ext.autodoc",
"sphinx.ext.intersphinx" "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 # The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes. # 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, # 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, # relative to this directory. They are copied after the builtin static files,

29
python/docs/index.rst
View File

@ -1,31 +1,20 @@
.. i2cdriver documentation master file, created by i2cdriver
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.
Excamera I2CDriver Python API 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.
zxxx
.. toctree:: .. toctree::
:maxdepth: 2 :maxdepth: 2
:caption: Contents:
xxcc The main page for I²CDriver includes the complete User Guide:
Official packages are available on PyPI.
https://pypi.org/project/i2cdriver/
The main page for I2CDriver includes the complete User Guide:
https://i2cdriver.com
https://i2cdriver.com/i2cdriver.pdf
System Requirements System Requirements
------------------- ===================
Because it is a pure Python module, ``i2cdriver`` can run on any system supported by ``pyserial``. Because it is a pure Python module, ``i2cdriver`` can run on any system supported by ``pyserial``.
This includes: This includes: