updated docs

Author: jlwalke2

CHANGELOG.md

@@ -4,9 +4,13 @@ Unreleased
  **Improvements**
 - Added `update_module` and `delete_module` methods to MAS service.
 
+**Changed**
+- Added `replace` parameter to `sasctl.tasks.publish_model` 
+
 **Bugfixes**
 - Renamed `microanalytic_store` service to `microanalytic_score` 
 
+
 v1.0.1 (2019-07-31)
 -------------------
 **Changed**

CONTRIBUTING.md

@@ -31,7 +31,7 @@ integration testing without requiring a running SAS Viya environment, the
 [Betamax](https://pypi.org/project/betamax/) package is used to record and
 replay network interactions.
 
-In addition, [Tox](https://tox.readthedocs.io) is used to automating development tasks
+In addition, [Tox](https://tox.readthedocs.io) is used to automate common development tasks
 such as testing, linting, and building documentation.
 
 All packages required for development and testing are listed in

doc/conf.py

@@ -54,7 +54,8 @@
                        'betamax': ('https://betamax.readthedocs.io/en/latest/', None),
                        'requests': (
                            'https://2.python-requests.org/en/master/', None),
-                       'tox': ('https://tox.readthedocs.io/en/latest/', None)}
+                       'tox': ('https://tox.readthedocs.io/en/latest/', None),
+                       'flake8': ('http://flake8.pycqa.org/en/latest/', None)}
 
 todo_include_todos = True
 

doc/index.rst

@@ -348,7 +348,8 @@ simple code examples that demonstrate how to use various features are always wel
 
 
 All documentation is contained in the :file:`doc/` directory of the source repository and is written in `reStructuredText`_.
-The .rst files are then processed by `Sphinx`_ to produce the final documentation.
+The .rst files are then processed by `Sphinx`_ to produce the final documentation.  See the :ref:`tox_commands` section for
+details on how to build the final documentation.
 
 .. _`reStructuredText`: http://docutils.sourceforge.net/rst.html
 .. _`Sphinx`: http://www.sphinx-doc.org/en/master/
@@ -375,6 +376,8 @@ part of the project.
 
   :command:`tox`
 
+  See :ref:`tox_commands` for more information on using Tox.
+
 3. If any tests fail, you should investigate and correct the failure *before* making any changes.
 #. Make your code changes
 #. Include new tests that validate your changes
@@ -390,19 +393,6 @@ All code submissions must meet the following requirements before the pull reques
 .. _`numpydoc`: https://numpydoc.readthedocs.io/en/latest/format.html
 
 
-Useful tox commands
-++++++++++++
-flake8
-pytest
-
-tox
-tox -e pyXX-flake8  # Linting/style checker
-tox -e pyXX-flake8 src/sasctl/...
-tox -e pyXX-tests
-tox -e pyXX-doc
-tox -e pyXX-tests -- python
-
-
 
 .. _testing:
 
@@ -432,6 +422,58 @@ And finally, the :doc:`tox <tox:index>` module is used to ensure that **sasctl**
 Python versions.
 
 
+.. _tox_commands:
+
+Useful Tox Commands
++++++++++++++++++++
+:mod:`tox`  is used to automate common development tasks such as testing, linting, and building documentation.
+Running :program:`tox` from the project root directory will automatically build virtual environments for all Python interpreters
+found on the system and then install the required packages necessary to perform a given task.  The simplest way to run Tox is:
+
+.. code::
+
+   $ tox
+
+This will run the :mod:`flake8` linter followed by :mod:`pytest` to test the code against all Python runtimes
+found on the machine.  One of the great features of Tox is the ability to run specific tasks by specifying the environment to run.
+A few useful environments are listed below, where **XX** indicates a Python version present in your development environment,
+such as '27' or '36'.
+
+#.
+   .. code::
+
+      $ tox -e pyXX-flake8
+
+   Runs the flake8 linter against all **sasctl** source code.
+
+#.
+   .. code::
+
+      $ tox -e pyXX-flake8 src/sasctl/tasks.py
+
+   Runs the flake8 linter against a specific file.
+
+#.
+   .. code::
+
+      $ tox -e pyXX-tests
+
+   Runs all tests using the specified Python interpreter.
+
+#.
+   .. code::
+
+      $ tox -e pyXX-doc
+
+   Builds the documentation.
+
+#.
+   .. code::
+
+      $ tox -e pyXX-tests -- python
+
+   Starts a Python REPL in an environment with **sasctl** already installed.
+
 Release History
 ---------------