A set of documentation updates (also let's see what happens when we p…

…ublish for second time to PyPI)

CONTRIBUTING.rst

@@ -79,7 +79,7 @@ Ready to contribute? Here's how to set up `pysonofflanr3` for local development.
 5. When you're done making changes, check that your changes pass flake8 and the
    tests, including testing other Python versions with tox::
 
-    $ flake8 pysonofflan tests
+    $ flake8 pysonofflanr3 tests
     $ python setup.py test or py.test
     $ tox
 

HISTORY.rst

@@ -5,7 +5,7 @@ History
 ------------------
 
 * First release on PyPI.
-* Forked from PySonoffLAN
+* Forked from PySonoffLAN package (courtesy of Andrew Beveridge)
 * Works on V3 Itead firmware using mDNS for service discovery and REST for service invocation
 * Supports DIY mode as well as 'standard' mode (for standard mode API key is needed to be obtained, e.g. by sniffing LAN)
 * Supports all known devices for switching, although no sensors added at this point

Makefile

@@ -51,7 +51,7 @@ clean-test: ## remove test and coverage artifacts
 	rm -fr .pytest_cache
 
 lint: ## check style with flake8
-	flake8 pysonofflan tests
+	flake8 pysonofflanr3 tests
 
 test: ## run tests quickly with the default Python
 	python setup.py test
@@ -60,7 +60,7 @@ test-all: ## run tests on every Python version with tox
 	tox
 
 coverage: ## check code coverage quickly with the default Python
-	coverage run --source pysonofflan setup.py test
+	coverage run --source pysonofflanr3 setup.py test
 	coverage report -m
 	coverage html
 	$(BROWSER) htmlcov/index.html

README.rst

@@ -1,6 +1,6 @@
-==============
-pysonofflan_r3
-==============
+=============
+pysonofflanr3
+=============
 
 
 .. image:: https://img.shields.io/pypi/v/pysonofflanr3.svg
@@ -74,13 +74,13 @@ Features
 Documentation
 ------------------
 
-* Documentation: https://pysonofflan.readthedocs.io.
+* Documentation: https://pysonofflanr3.readthedocs.io.
 
 Install
 ------------------
 ::
 
-    $ pip install pysonofflan
+    $ pip install pysonofflanr3
 
 Command-Line Usage
 ------------------

docs/conf.py

@@ -22,7 +22,7 @@
 import sys
 sys.path.insert(0, os.path.abspath('..'))
 
-import pysonofflan
+import pysonofflanr3
 
 # -- General configuration ---------------------------------------------
 
@@ -47,18 +47,18 @@
 master_doc = 'index'
 
 # General information about the project.
-project = u'pySonoffLAN'
-copyright = u"2019, Andrew Beveridge"
-author = u"Andrew Beveridge"
+project = u'pySonoffLANR3'
+copyright = u"2019-2020, Matt Saxon, Andrew Beveridge"
+author = u"Matt Saxon"
 
 # The version info for the project you're documenting, acts as replacement
 # for |version| and |release|, also used in various other places throughout
 # the built documents.
 #
 # The short X.Y version.
-version = pysonofflan.__version__
+version = pysonofflanr3.__version__
 # The full version, including alpha/beta/rc tags.
-release = pysonofflan.__version__
+release = pysonofflanr3.__version__
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
@@ -101,7 +101,7 @@
 # -- Options for HTMLHelp output ---------------------------------------
 
 # Output file base name for HTML help builder.
-htmlhelp_basename = 'pysonofflandoc'
+htmlhelp_basename = 'pysonofflanr3doc'
 
 
 # -- Options for LaTeX output ------------------------------------------
@@ -128,7 +128,7 @@
 # (source start file, target name, title, author, documentclass
 # [howto, manual, or own class]).
 latex_documents = [
-    (master_doc, 'pysonofflan.tex',
+    (master_doc, 'pysonofflanr3.tex',
      u'pySonoffLAN Documentation',
      u'Andrew Beveridge', 'manual'),
 ]
@@ -139,8 +139,8 @@
 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
 man_pages = [
-    (master_doc, 'pysonofflan',
-     u'pySonoffLAN Documentation',
+    (master_doc, 'pysonofflanr3',
+     u'pySonoffLANR3 Documentation',
      [author], 1)
 ]
 
@@ -151,10 +151,10 @@
 # (source start file, target name, title, author,
 #  dir menu entry, description, category)
 texinfo_documents = [
-    (master_doc, 'pysonofflan',
-     u'pySonoffLAN Documentation',
+    (master_doc, 'pysonofflanr3',
+     u'pySonoffLANR3 Documentation',
      author,
-     'pysonofflan',
+     'pysonofflanr3',
      'One line description of project.',
      'Miscellaneous'),
 ]

docs/index.rst

@@ -7,8 +7,6 @@ Welcome to pySonoffLAN's documentation!
 
    readme
    installation
-   usage
-   modules
    contributing
    authors
    history

docs/installation.rst

@@ -12,9 +12,9 @@ To install pySonoffLAN, run this command in your terminal:
 
 .. code-block:: console
 
-    $ pip install pysonofflan
+    $ pip install pysonofflanr3
 
-This is the preferred method to install pySonoffLAN, as it will always install the most recent stable release.
+This is the preferred method to install pySonoffLANR3, as it will always install the most recent stable release.
 
 If you don't have `pip`_ installed, this `Python installation guide`_ can guide
 you through the process.
@@ -26,19 +26,19 @@ you through the process.
 From sources
 ------------
 
-The sources for pySonoffLAN can be downloaded from the `Github repo`_.
+The sources for pySonoffLANR3 can be downloaded from the `Github repo`_.
 
 You can either clone the public repository:
 
 .. code-block:: console
 
-    $ git clone git://github.com/beveradb/pysonofflan
+    $ git clone git://github.com/mattsaxon/pysonofflan
 
 Or download the `tarball`_:
 
 .. code-block:: console
 
-    $ curl  -OL https://github.com/beveradb/pysonofflan/tarball/master
+    $ curl  -OL https://github.com/mattsaxon/pysonofflan/tarball/master
 
 Once you have a copy of the source, you can install it with:
 
@@ -47,5 +47,5 @@ Once you have a copy of the source, you can install it with:
     $ python setup.py install
 
 
-.. _Github repo: https://github.com/beveradb/pysonofflan
-.. _tarball: https://github.com/beveradb/pysonofflan/tarball/master
+.. _Github repo: https://github.com/mattsaxon/pysonofflan
+.. _tarball: https://github.com/mattsaxon/pysonofflan/tarball/master