Merge pull request #4 from QCoDeS/master

update
nulinspiratie · Dec 1, 2017 · 4ed2dd3 · 4ed2dd3
2 parents 341dd9a + f3a269c
commit 4ed2dd3
Show file tree

Hide file tree

Showing 15 changed files with 3,364 additions and 386 deletions.
diff --git a/README.rst b/README.rst
@@ -60,19 +60,19 @@ Developer-pyenv
 
 Core developers use virtualenv and pyenv to make sure all the system are the same,
 this rules out issues and the usual "it works on my machine". Install pyenv
-on your OS `see this <https://github.com/yyuu/pyenv>`__ .
+on your OS `see this <https://github.com/pyenv/pyenv>`__ .
 
 $QCODES_INSTALL_DIR is the folder where you want to have the source code.
 
 .. code:: bash
 
     git clone https://github.com/QCoDeS/Qcodes.git $QCODES_INSTALL_DIR
     cd $QCODES_INSTALL_DIR
-    pyenv install 3.5.2
-    pyenv virtualenv 3.5.2 qcodes-dev
+    pyenv install 3.6.3
+    pyenv virtualenv 3.6.3 qcodes-dev
     pyenv activate qcodes-dev
     pip install -r requirements.txt
-    pip install coverage pytest-cov pytest --upgrade
+    pip install -r test_requirements.txt --upgrade
     pip install -e .
     py.test --cov=qcodes --cov-config=.coveragerc
 
@@ -112,11 +112,17 @@ Documentation is updated and deployed on every successful build in master.
 We use sphinx for documentations, makefiles are provided both for
 Windows, and \*nix.
 
+Make sure that you have the extra dependencies required to install the docs
+
+.. code:: bash
+
+    pip install -r docs_requirements.txt
+
 Go to the directory ``docs`` and
 
 .. code:: bash
 
-    make html
+    make html-api
 
 This generate a webpage, index.html, in ``docs/_build/html`` with the
 rendered html. 

diff --git a/docs/examples/driver_examples/QCodes example with SR830.ipynb b/docs/examples/driver_examples/QCodes example with SR830.ipynb
@@ -1005,7 +1005,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.5.3"
+   "version": "3.6.3"
   }
  },
  "nbformat": 4,

diff --git a/docs/examples/driver_examples/QCodes_example_with_SR86x_with_buffered_readout.ipynb b/docs/examples/driver_examples/QCodes_example_with_SR86x_with_buffered_readout.ipynb
diff --git a/docs/examples/driver_examples/Qcodes example with HP8753D.ipynb b/docs/examples/driver_examples/Qcodes example with HP8753D.ipynb
@@ -16,7 +16,9 @@
   {
    "cell_type": "code",
    "execution_count": 1,
-   "metadata": {},
+   "metadata": {
+    "collapsed": true
+   },
    "outputs": [],
    "source": [
     "# allow in-notebook matplotlib plots\n",
@@ -103,7 +105,9 @@
   {
    "cell_type": "code",
    "execution_count": 5,
-   "metadata": {},
+   "metadata": {
+    "collapsed": true
+   },
    "outputs": [],
    "source": [
     "# Let's get a single trace of S21 with 10 averages\n",
@@ -1039,7 +1043,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.6.0"
+   "version": "3.6.2"
   }
  },
  "nbformat": 4,