more doc tidying

Author: felliott

CONTRIBUTING.rst

@@ -24,27 +24,30 @@ Clone the repo: ::
     $ git clone https://github.com/CenterForOpenScience/modular-file-renderer.git
     $ cd modular-file-renderer
 
-Configure development environment and Install the development dependencies.
+Configure development environment and install the development dependencies.
 
 .. note::
 
-    It is recommended that you use a `virtualenv`_ with `virtualenvwrapper`_ during development. Python 3.5 and R are required.
+    It is recommended that you use a `virtualenv`_ with `virtualenvwrapper`_ during development. Python 3.5 or greater, `R`_, and `pspp`_ are required.
 
 .. _virtualenv: http://www.virtualenv.org/en/latest/
 .. _virtualenvwrapper: https://pypi.python.org/pypi/virtualenvwrapper
+.. _R: https://www.r-project.org/
+.. _pspp: https://www.gnu.org/software/pspp/
 
 .. code-block:: bash
 
     # For Mac OS X: Install the latest version of python3.5
     $ brew install python3
-    $ brew install r
+    $ brew install r pspp
 
     # Linux users, probably the same thing but with apt-get
     # If someone wants to update this guide, please do.
 
     $ pip install virtualenv
     $ pip install virtualenvwrapper
     $ mkvirtualenv --python=`which python3` mfr
+    $ pip install setuptools==30.4.0
     $ pip install invoke==0.13.0
 
 

README.md

@@ -10,7 +10,6 @@ A Python package for rendering files to HTML via an embeddable iframe.
 
 MFR is compatible with Python 3.5 (tested up to 3.5.3) and 3.6.
 
-
 ### Documentation
 
 Documentation available at: http://modular-file-renderer.readthedocs.io/en/latest/
@@ -83,9 +82,9 @@ invoke install --develop
 invoke test
 ```
 
-### Known Issues
+### Known issues
 
- - Running `invoke install -d` with setuptools v31 or greater can break MFR.  The symptom error message is: `"AttributeError: module 'mfr' has no attribute '__version__'".`  If you encounter this, you will need to remove the file
+- Running `invoke install -d` with setuptools v31 or greater can break MFR.  The symptom error message is: `"AttributeError: module 'mfr' has no attribute '__version__'".`  If you encounter this, you will need to remove the file
 `mfr-nspkg.pth` from your virtualenv directory, run `pip install setuptools==30.4.0`, then re-run `invoke install -d`.
 
 - The error `def create_default_context(purpose=ssl.Purpose.SERVER_AUTH, *, cafile=None, capath=None, cadata=None): SyntaxError: invalid syntax` can be fixed by restarting your virtual environment. The problem should not reoccur.
@@ -114,4 +113,4 @@ limitations under the License.
 
 ### COS is hiring!
 
-Want to help save science? Want to get paid to develop free, open source software? [Check out our openings!](https://cos.io/jobs/)
+Want to help save science? Want to get paid to develop free, open source software? [Check out our openings!](https://cos.io/our-communities/jobs/)

docs/install.rst

@@ -14,14 +14,13 @@ Or download one of the following:
 * tarball_
 * zipball_
 
-Make sure that you have installed pspp, are using python3.5, and have installed invoke for your current python3 version.
+Make sure that you have installed `pspp <https://www.gnu.org/software/pspp/>`_ and are using python 3.5 or greater.
 
-Install the version of invoke found in the requirements.txt file. Currently 0.13.0
-
-Install ``invoke``:
+Install the versions of ``setuptools`` and ``invoke`` found in the requirements.txt file:
 
 .. code-block:: bash
 
+    pip install setuptools==30.4.0
     pip install invoke==0.13.0
 
 Install requirements: