Resolve conflicts upon merging with _using_pyvisa

Author: hgrecco

.gitignore

@@ -5,6 +5,7 @@ _past*
 *.pyc
 .DS_Store
 docs/_build/
+docs/_snippets/
 docs/drivers
 .idea
 _test*

docs/_static/blocks/loop.png

@@ -0,0 +1,90 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<ui version="4.0">
+ <class>MainWindow</class>
+ <widget class="QMainWindow" name="MainWindow">
+  <property name="geometry">
+   <rect>
+    <x>0</x>
+    <y>0</y>
+    <width>328</width>
+    <height>231</height>
+   </rect>
+  </property>
+  <property name="windowTitle">
+   <string>Function Generator</string>
+  </property>
+  <widget class="QWidget" name="centralwidget">
+   <layout class="QVBoxLayout" name="verticalLayout">
+    <item>
+     <widget class="QGroupBox" name="configBox">
+      <property name="title">
+       <string>Configuration</string>
+      </property>
+      <layout class="QVBoxLayout" name="verticalLayout_3">
+       <item>
+        <layout class="QFormLayout" name="formLayout">
+         <property name="fieldGrowthPolicy">
+          <enum>QFormLayout::FieldsStayAtSizeHint</enum>
+         </property>
+         <item row="0" column="0">
+          <widget class="QLabel" name="amplitudeLabel">
+           <property name="text">
+            <string>Amplitude</string>
+           </property>
+          </widget>
+         </item>
+         <item row="0" column="1">
+          <widget class="QDoubleSpinBox" name="amplitude"/>
+         </item>
+         <item row="1" column="0">
+          <widget class="QLabel" name="offsetLabel">
+           <property name="text">
+            <string>Offset</string>
+           </property>
+          </widget>
+         </item>
+         <item row="1" column="1">
+          <widget class="QDoubleSpinBox" name="offset"/>
+         </item>
+         <item row="2" column="0">
+          <widget class="QLabel" name="waveformLabel">
+           <property name="text">
+            <string>Waveform</string>
+           </property>
+          </widget>
+         </item>
+         <item row="2" column="1">
+          <widget class="QComboBox" name="waveform"/>
+         </item>
+         <item row="3" column="0">
+          <widget class="QLabel" name="frequencyLabel">
+           <property name="text">
+            <string>Frequency</string>
+           </property>
+          </widget>
+         </item>
+         <item row="3" column="1">
+          <widget class="QDoubleSpinBox" name="frequency"/>
+         </item>
+        </layout>
+       </item>
+      </layout>
+     </widget>
+    </item>
+   </layout>
+  </widget>
+  <widget class="QMenuBar" name="menubar">
+   <property name="geometry">
+    <rect>
+     <x>0</x>
+     <y>0</y>
+     <width>328</width>
+     <height>22</height>
+    </rect>
+   </property>
+  </widget>
+  <widget class="QStatusBar" name="statusbar"/>
+ </widget>
+ <resources/>
+ <connections/>
+</ui>

docs/_static/blocks/scan.png

@@ -1,5 +1,9 @@
 .. _agreement:
 
+
+Agreeement
+----------
+
 .. raw:: html
 
     <iframe src="https://docs.google.com/spreadsheet/embeddedform?formkey=dEs1Qmk5bU1ua1dPcS1kX1A1bmtjS1E6MQ" width="760" height="816" frameborder="0" marginheight="0" marginwidth="0">Loading...</iframe>

docs/_static/blocks/scanfeat.png

@@ -2,18 +2,10 @@
 Interfacing to instruments
 ==========================
 
-.. automodule:: lantz.serial
-   :members:
-   :show-inheritance:
-
-.. automodule:: lantz.network
+.. automodule:: lantz.messagebased
    :members:
    :show-inheritance:
 
 .. automodule:: lantz.foreign
    :members:
    :show-inheritance:
-
-.. automodule:: lantz.visa
-   :members:
-   :show-inheritance:

docs/_static/guides/scanfrequency.png

@@ -7,6 +7,5 @@ Support
 
    stats
    processors
-   visalib
    stringparser
 

docs/_static/tutorial/scanfrequency.ui docs/_static/guides/scanfrequency.ui

@@ -15,6 +15,20 @@
 import pkg_resources
 import datetime
 
+os.environ['QT_API'] = 'mock'
+os.environ['LANTZ_BUILDING_DOCS'] = 'True'
+
+from unittest.mock import MagicMock
+
+class Mock(MagicMock):
+
+    @classmethod
+    def __getattr__(cls, name):
+        return Mock()
+
+MOCK_MODULES = ['numpy', ]
+sys.modules.update((mod_name, Mock()) for mod_name in MOCK_MODULES)
+
 # If extensions (or modules to document with autodoc) are in another directory,
 # add these directories to sys.path here. If the directory is relative to the
 # documentation root, use os.path.abspath to make it absolute, like shown here.
@@ -29,10 +43,12 @@
 # Add any Sphinx extension module names here, as strings. They can be extensions
 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
 extensions = ['sphinx.ext.viewcode', 'sphinx.ext.autodoc', 'sphinx.ext.intersphinx',
+              'sphinxcontrib.images',
               ]#'autodriver']
 #	      'sphinxcontrib.spelling']
 
-intersphinx_mapping = {'python': ('http://docs.python.org/3.2', None)}
+intersphinx_mapping = {'python': ('http://docs.python.org/3.4', None),
+                       'pyvisa': ('http://pyvisa.readthedocs.org/en/latest', None)}
 
 autodoc_member_order = 'groupwise'
 autoclass_content = 'both'
@@ -57,7 +73,11 @@
 # |version| and |release|, also used in various other places throughout the
 # built documents.
 
-version = pkg_resources.get_distribution(project).version
+try:
+    version = pkg_resources.get_distribution(project).version
+except:
+    version = 'unknown'
+
 release = version
 this_year = datetime.date.today().year
 copyright = '%s, %s' % (this_year, author)
@@ -96,24 +116,29 @@
 # A list of ignored prefixes for module index sorting.
 modindex_common_prefix = ['lantz.']
 
-
-import driversdoc
-driversdoc.main()
-
 # -- Options for HTML output ---------------------------------------------------
-sys.path.append(os.path.abspath('_themes'))
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
-html_theme = 'lantz'
+html_theme = 'sphinx_rtd_theme'
+
+on_rtd = os.environ.get('READTHEDOCS', None) == 'True'
+
+if not on_rtd:  # only import and set the theme if we're building docs locally
+    try:
+        import sphinx_rtd_theme
+    except ImportError:
+        print('\n\nTheme not found. Please install Sphinx Read The Docs Themes using:\n\n'
+              '   pip install sphinx_rtd_theme\n')
+        sys.exit(1)
+    html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
+
+import driversdoc
+driversdoc.main()
 
 # Theme options are theme-specific and customize the look and feel of a theme
 # further.  For a list of options available for each theme, see the
 # documentation.
-#html_theme_options = {}
-html_theme_options = {'collapsiblesidebar': True}
-
-# Add any paths that contain custom themes here, relative to this directory.
-html_theme_path = ['_themes']
+html_theme_options = {}
 
 # The name for this set of Sphinx documents.  If None, it defaults to
 # "<project> v<release> documentation".

docs/_static/tutorial/fungen.ui

@@ -16,7 +16,7 @@ There are always at least two branches:
     * master: appropriate for users. It must always be in a working state.
     * develop: appropriate for developers. Might not be in a working state.
 
-The master branch only accepts atomic, small commits. Larger changes that might break the master branch should happen in the develop branch. The develop branch will be merged into the master after deep testing. If you want to refactor major parts of the code or try new ideas, create a dedicated branch. This branch will merged into develop once tested.
+The master branch only accepts atomic, small commits. Larger changes that might break the master branch should happen in the develop branch . The develop branch will be merged into the master after deep testing. If you want to refactor major parts of the code or try new ideas, create a dedicated branch. This will merged into develop once tested.
 
 The easiest way to start hacking Lantz codebase is using a virtual environment
 and cloning an editable package.
@@ -133,7 +133,7 @@ module, a small description and the copyright message. For example:
 Submitting your changes
 -----------------------
 
-Changes must be submitted for merging as patches or pull requests.
+Changes must be submitted for merging as pull requests.
 
 Before doing so, please check that:
     * The new code is functional.
@@ -143,14 +143,7 @@ Before doing so, please check that:
     * Any new file contains an appropriate header.
     * You commit to the head of the appropriate branch (usually develop).
 
-Commits must include a one-line description of the intended change followed, if necessary, by an empty line and detailed description. You can send your patch by e-mail to `[email protected]`::
-
-    $ git format-patch origin/develop..develop
-    0001-Changed-Driver-class-to-enable-inheritance-of-Action.patch
-    0002-Added-RECV_CHUNK-to-TextualMixin.patch
-
-
-or send a pull request.
+Commits must include a one-line description of the intended change followed, if necessary, by an empty line and detailed description..
 
 
 Copyright
@@ -183,3 +176,4 @@ Finally, we have a small Zen
 .. _git: http://git-scm.com/
 .. _reStructuredText: http://docutils.sf.net/rst.html
 .. _Sphinx: http://sphinx.pocoo.org/
+.. _`Lantz at Github`: https://github.com/hgrecco/lantz/

docs/_static/tutorial/gui-app.png

@@ -5,14 +5,15 @@ Contributing Drivers
 ====================
 
 The most straightforward way to contribute to Lantz is by submitting instrument
-drivers. You do not need to clone or understand the whole structure of `Lantz`
-for this purpose and you can do it directly from you own projects.
+drivers as you do not need to understand the whole structure of `Lantz`.
 
-If you have installed Lantz using the tutorial (:ref:`installing`), you
+There are two ways:
 
-    $ lantz-contribute <filename>
+- Clone the repo in github and do a pull request
+- Upload your code to a gist_,
 
 Please be sure that you have documented the code properly before submission. You
 can also use this tool if you want some feedback about your code.
 
 
+.. _gist: https://gist.github.com/

docs/_static/tutorial/rich-gui-app.png

@@ -306,6 +306,7 @@ def list_drivers(key, module):
 
 def list_packages(root_package):
     packages = {}
+    failed_packages = []
     path, prefix = root_package.__path__, root_package.__name__ + "."
     for importer, modname, ispkg in pkgutil.iter_modules(path, prefix):
         if not ispkg:
@@ -315,12 +316,13 @@ def list_packages(root_package):
             packages[package.__name__] = package
             print('+ Imported {}'.format(modname))
         except Exception as e:
+            failed_packages.append(modname)
             print('- Cannot import {}: {}'.format(modname, e))
-    return packages
+    return packages, failed_packages
 
 def main():
     print('\nGenerating documentation for drivers ...')
-    packages = list_packages(drivers)
+    packages, failed_packages = list_packages(drivers)
     class opts:
         pass
     opts.dryrun = False
@@ -341,6 +343,8 @@ class opts:
         fp.write('   *\n')
         last = ''
         for key in sorted(packages.keys()):
+            if key == 'legacy':
+                continue
             try:
                 company = company_parser(packages[key].__doc__).strip()
             except Exception as e:
@@ -355,5 +359,11 @@ class opts:
             module = packages[key]
             fp.write(list_drivers(key, module))
 
+        if failed_packages:
+            fp.write(format_heading(1, 'Failed to generate the docs for the following subpackages'))
+            fp.write('\n')
+            for key in sorted(failed_packages):
+                fp.write('- {}\n'.format(key))
+
 if __name__ == '__main__':
     main()

docs/agreement.rst

@@ -0,0 +1,50 @@
+# -*- coding: utf-8 -*-
+
+import os
+
+from docutils.core import publish_doctree
+from docutils.nodes import literal_block
+
+
+def extract_snippets(filename):
+    with open(filename, 'r') as fp:
+        doctree = publish_doctree(fp.read())
+
+    for part in doctree.traverse(literal_block):
+        if not part.attributes.get('classes', None) == ['code', 'python']:
+            continue
+        yield part.rawsource
+
+
+def main(doc_folder=None):
+    if doc_folder is None:
+        doc_folder = os.getcwd()
+
+    join = os.path.join
+
+    snippet_folder = join(doc_folder, '_snippets')
+
+    print('Scanning %s' % doc_folder)
+    print('Extracting snippets to %s' % snippet_folder)
+
+    for root, dirs, files in os.walk(doc_folder, topdown=True):
+        dirs[:] = [d for d in dirs
+                   if d[0] != '_' and d not in ('drivers', 'api')]
+
+        dst_folder = join(snippet_folder, root[(len(doc_folder)+1):])
+
+        try:
+            os.mkdir(dst_folder)
+        except:
+            pass
+
+        for name in files:
+            if not name.endswith('.rst'):
+                continue
+
+            for ndx, snippet in enumerate(extract_snippets(join(root, name))):
+                with open(join(dst_folder, '%s_%02d.py' % (name, ndx)), 'w', encoding='utf-8') as fo:
+                    fo.write(snippet)
+
+if __name__ == '__main__':
+    main()

docs/api/interfaces.rst

@@ -62,7 +62,7 @@ Slow operations such as numerical calculations are done using libraries such as
 How do I start?
 ---------------
 
-The :ref:`tutorial` is a good place.
+The :ref:`tutorials` is a good place.
 
 
 I want to help. What can I do?