[Python-modules-commits] [python-qtconsole] 01/02: Imported Upstream version 4.2.1

Frédéric-Emmanuel Picca picca at moszumanska.debian.org
Sat Jun 11 15:38:52 UTC 2016


This is an automated email from the git hooks/post-receive script.

picca pushed a commit to branch master
in repository python-qtconsole.

commit 82482a93727a904d9fa68382d09aa5e42e8b570e
Author: Picca Frédéric-Emmanuel <picca at debian.org>
Date:   Sun Jun 5 10:29:14 2016 +0200

    Imported Upstream version 4.2.1
---
 CONTRIBUTING.md                             |    3 +
 COPYING.md                                  |   60 +
 PKG-INFO                                    |   21 +
 README.md                                   |   70 +
 docs/Makefile                               |  204 +++
 docs/autogen_config.py                      |   22 +
 docs/conda-env.yml                          |   12 +
 docs/gh-pages.py                            |  136 ++
 docs/requirements.txt                       |    4 +
 docs/source/_images/qtconsole.png           |  Bin 0 -> 153249 bytes
 docs/source/changelog.rst                   |   69 +
 docs/source/conf.py                         |  318 ++++
 docs/source/figs/besselj.png                |  Bin 0 -> 53726 bytes
 docs/source/figs/colors_dark.png            |  Bin 0 -> 61184 bytes
 docs/source/figs/jn.html                    |  690 +++++++++
 docs/source/figs/jn.xhtml                   |  375 +++++
 docs/source/index.rst                       |  462 ++++++
 docs/source/installation.rst                |   54 +
 examples/inprocess_qtconsole.py             |   37 +
 examples/jupyter-qtconsole.desktop          |   14 +
 qtconsole/__init__.py                       |    1 +
 qtconsole/__main__.py                       |    3 +
 qtconsole/_version.py                       |    2 +
 qtconsole/ansi_code_processor.py            |  378 +++++
 qtconsole/base_frontend_mixin.py            |  183 +++
 qtconsole/bracket_matcher.py                |  100 ++
 qtconsole/call_tip_widget.py                |  261 ++++
 qtconsole/client.py                         |   71 +
 qtconsole/completion_html.py                |  373 +++++
 qtconsole/completion_plain.py               |   57 +
 qtconsole/completion_widget.py              |  155 ++
 qtconsole/console_widget.py                 | 2138 +++++++++++++++++++++++++++
 qtconsole/frontend_widget.py                |  847 +++++++++++
 qtconsole/history_console_widget.py         |  263 ++++
 qtconsole/inprocess.py                      |   90 ++
 qtconsole/ipython_widget.py                 |    3 +
 qtconsole/jupyter_widget.py                 |  548 +++++++
 qtconsole/kernel_mixins.py                  |   50 +
 qtconsole/kill_ring.py                      |  128 ++
 qtconsole/mainwindow.py                     |  781 ++++++++++
 qtconsole/manager.py                        |   53 +
 qtconsole/pygments_highlighter.py           |  232 +++
 qtconsole/qt.py                             |   23 +
 qtconsole/qt_loaders.py                     |  309 ++++
 qtconsole/qtconsoleapp.py                   |  400 +++++
 qtconsole/resources/icon/JupyterConsole.svg |  569 +++++++
 qtconsole/rich_ipython_widget.py            |    3 +
 qtconsole/rich_jupyter_widget.py            |  407 +++++
 qtconsole/rich_text.py                      |  234 +++
 qtconsole/styles.py                         |  122 ++
 qtconsole/svg.py                            |   91 ++
 qtconsole/tests/__init__.py                 |    0
 qtconsole/tests/test_ansi_code_processor.py |  171 +++
 qtconsole/tests/test_app.py                 |   30 +
 qtconsole/tests/test_completion_widget.py   |   70 +
 qtconsole/tests/test_console_widget.py      |   79 +
 qtconsole/tests/test_kill_ring.py           |   84 ++
 qtconsole/usage.py                          |  194 +++
 qtconsole/util.py                           |  109 ++
 scripts/jupyter-qtconsole                   |    5 +
 setup.cfg                                   |    2 +
 setup.py                                    |  107 ++
 62 files changed, 12277 insertions(+)

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644
index 0000000..6b73dbf
--- /dev/null
+++ b/CONTRIBUTING.md
@@ -0,0 +1,3 @@
+# Contributing
+
+We follow the [IPython Contributing Guide](https://github.com/ipython/ipython/blob/master/CONTRIBUTING.md).
diff --git a/COPYING.md b/COPYING.md
new file mode 100644
index 0000000..bd6397d
--- /dev/null
+++ b/COPYING.md
@@ -0,0 +1,60 @@
+# Licensing terms
+
+This project is licensed under the terms of the Modified BSD License
+(also known as New or Revised or 3-Clause BSD), as follows:
+
+- Copyright (c) 2001-2015, IPython Development Team
+- Copyright (c) 2015-, Jupyter Development Team
+
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+Redistributions of source code must retain the above copyright notice, this
+list of conditions and the following disclaimer.
+
+Redistributions in binary form must reproduce the above copyright notice, this
+list of conditions and the following disclaimer in the documentation and/or
+other materials provided with the distribution.
+
+Neither the name of the Jupyter Development Team nor the names of its
+contributors may be used to endorse or promote products derived from this
+software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+## About the Jupyter Development Team
+
+The Jupyter Development Team is the set of all contributors to the Jupyter project.
+This includes all of the Jupyter subprojects.
+
+The core team that coordinates development on GitHub can be found here:
+https://github.com/jupyter/.
+
+## Our Copyright Policy
+
+Jupyter uses a shared copyright model. Each contributor maintains copyright
+over their contributions to Jupyter. But, it is important to note that these
+contributions are typically only changes to the repositories. Thus, the Jupyter
+source code, in its entirety is not the copyright of any single person or
+institution.  Instead, it is the collective copyright of the entire Jupyter
+Development Team.  If individual contributors want to maintain a record of what
+changes/contributions they have specific copyright on, they should indicate
+their copyright in the commit message of the change, when they commit the
+change to one of the Jupyter repositories.
+
+With this in mind, the following banner should be used in any source code file
+to indicate the copyright and license terms:
+
+    # Copyright (c) Jupyter Development Team.
+    # Distributed under the terms of the Modified BSD License.
diff --git a/PKG-INFO b/PKG-INFO
new file mode 100644
index 0000000..1369710
--- /dev/null
+++ b/PKG-INFO
@@ -0,0 +1,21 @@
+Metadata-Version: 1.1
+Name: qtconsole
+Version: 4.2.1
+Summary: Jupyter Qt console
+Home-page: http://jupyter.org
+Author: Jupyter Development Team
+Author-email: jupyter at googlegroups.com
+License: BSD
+Description: Qt-based console for Jupyter with support for rich media output
+Keywords: Interactive,Interpreter,Shell
+Platform: Linux
+Platform: Mac OS X
+Platform: Windows
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: System Administrators
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: BSD License
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 2.7
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.3
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..dcf8f4a
--- /dev/null
+++ b/README.md
@@ -0,0 +1,70 @@
+# Jupyter Qt Console
+
+[![Google Group](https://img.shields.io/badge/-Google%20Group-lightgrey.svg)](https://groups.google.com/forum/#!forum/jupyter)
+[![Build Status](https://travis-ci.org/jupyter/qtconsole.svg?branch=master)](https://travis-ci.org/jupyter/qtconsole)
+[![Documentation Status](https://readthedocs.org/projects/qtconsole/badge/?version=stable)](http://qtconsole.readthedocs.org/en/stable/)
+
+A rich Qt-based console for working with Jupyter kernels,
+supporting rich media output, session export, and more.
+
+The Qt console is a very lightweight application that largely feels like a terminal, but
+provides a number of enhancements only possible in a GUI, such as inline
+figures, proper multiline editing with syntax highlighting, graphical calltips,
+and more.
+
+![qtconsole](docs/source/_images/qtconsole.png)
+
+## Install Qt console
+The Qt console requires Qt, such as [PyQt5](http://www.riverbankcomputing.com/software/pyqt/intro),
+[PyQt4](https://www.riverbankcomputing.com/software/pyqt/download),
+or [PySide](http://pyside.github.io/docs/pyside).
+
+Although [pip](https://pypi.python.org/pypi/pip) and
+[conda](http://conda.pydata.org/docs) may be used to install the Qt console, conda
+is simpler to use since it automatically installs PyQt. Alternatively,
+the Qt console installation with pip needs additional steps since pip cannot install
+the Qt requirement.
+
+### Install using conda
+To install:
+
+    conda install qtconsole
+
+**Note:** If the Qt console is installed using conda, it will **automatically**
+install the Qt requirement as well.
+
+### Install using pip
+To install:
+
+    pip install qtconsole
+
+**Note:** Make sure that Qt is installed. Unfortunately, Qt cannot be
+installed using pip. The next section gives instructions on installing Qt.
+
+### Installing Qt (if needed)
+We recommend installing PyQt with [conda](http://conda.pydata.org/docs):
+
+    conda install pyqt
+
+or with a system package manager. For Windows, PyQt binary packages may be
+used.
+
+**Note:** Additional information about using a system package manager may be
+found in the [qtconsole documentation](https://qtconsole.readthedocs.org). For
+example, on Linux Debian/Ubuntu, use ``sudo apt-get install python3-pyqt5`` to
+install PyQt5, ``sudo apt-get install python-qt4`` or
+``sudo apt-get install python3-pyqt4`` to install PyQt4.
+
+## Usage
+To run the Qt console:
+
+    jupyter qtconsole
+
+## Resources
+- [Project Jupyter website](https://jupyter.org)
+- Documentation for the Qt console
+  * [latest version](http://qtconsole.readthedocs.org/en/latest/) [[PDF](https://media.readthedocs.org/pdf/qtconsole/latest/qtconsole.pdf)]
+  * [stable version](http://qtconsole.readthedocs.org/en/stable/) [[PDF](https://media.readthedocs.org/pdf/qtconsole/stable/qtconsole.pdf)]
+- [Documentation for Project Jupyter](http://jupyter.readthedocs.org/en/latest/index.html) [[PDF](https://media.readthedocs.org/pdf/jupyter/latest/jupyter.pdf)]
+- [Issues](https://github.com/jupyter/qtconsole/issues)
+- [Technical support - Jupyter Google Group](https://groups.google.com/forum/#!forum/jupyter)
diff --git a/docs/Makefile b/docs/Makefile
new file mode 100644
index 0000000..c281c18
--- /dev/null
+++ b/docs/Makefile
@@ -0,0 +1,204 @@
+# Makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+PAPER         =
+BUILDDIR      = build
+
+# User-friendly check for sphinx-build
+ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)
+$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/)
+endif
+
+# Internal variables.
+PAPEROPT_a4     = -D latex_paper_size=a4
+PAPEROPT_letter = -D latex_paper_size=letter
+ALLSPHINXOPTS   = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
+# the i18n builder cannot share the environment and doctrees with the others
+I18NSPHINXOPTS  = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
+
+.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest coverage gettext
+
+help:
+	@echo "Please use \`make <target>' where <target> is one of"
+	@echo "  html       to make standalone HTML files"
+	@echo "  gh-pages   clone qtconsole docs in ./gh-pages/ , build doc, autocommit"
+	@echo "  dirhtml    to make HTML files named index.html in directories"
+	@echo "  singlehtml to make a single large HTML file"
+	@echo "  pickle     to make pickle files"
+	@echo "  json       to make JSON files"
+	@echo "  htmlhelp   to make HTML files and a HTML help project"
+	@echo "  qthelp     to make HTML files and a qthelp project"
+	@echo "  applehelp  to make an Apple Help Book"
+	@echo "  devhelp    to make HTML files and a Devhelp project"
+	@echo "  epub       to make an epub"
+	@echo "  latex      to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
+	@echo "  latexpdf   to make LaTeX files and run them through pdflatex"
+	@echo "  latexpdfja to make LaTeX files and run them through platex/dvipdfmx"
+	@echo "  text       to make text files"
+	@echo "  man        to make manual pages"
+	@echo "  texinfo    to make Texinfo files"
+	@echo "  info       to make Texinfo files and run them through makeinfo"
+	@echo "  gettext    to make PO message catalogs"
+	@echo "  changes    to make an overview of all changed/added/deprecated items"
+	@echo "  xml        to make Docutils-native XML files"
+	@echo "  pseudoxml  to make pseudoxml-XML files for display purposes"
+	@echo "  linkcheck  to check all external links for integrity"
+	@echo "  doctest    to run all doctests embedded in the documentation (if enabled)"
+	@echo "  coverage   to run coverage check of the documentation (if enabled)"
+
+clean:
+	rm -rf $(BUILDDIR)/*
+	rm -rf source/config_options.rst
+
+html: source/config_options.rst
+	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
+	@echo
+	@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
+
+source/config_options.rst:
+	python3 autogen_config.py
+	@echo "Created docs for config options"
+
+gh-pages: clean html
+	# if VERSION is unspecified, it will be dev
+	# For releases, VERSION should be just the major version,
+	# e.g. VERSION=2 make gh-pages
+	python3 gh-pages.py $(VERSION)
+
+dirhtml:
+	$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
+	@echo
+	@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
+
+singlehtml:
+	$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
+	@echo
+	@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
+
+pickle:
+	$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
+	@echo
+	@echo "Build finished; now you can process the pickle files."
+
+json:
+	$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
+	@echo
+	@echo "Build finished; now you can process the JSON files."
+
+htmlhelp:
+	$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
+	@echo
+	@echo "Build finished; now you can run HTML Help Workshop with the" \
+	      ".hhp project file in $(BUILDDIR)/htmlhelp."
+
+qthelp:
+	$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
+	@echo
+	@echo "Build finished; now you can run "qcollectiongenerator" with the" \
+	      ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
+	@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/JupyterQtConsole.qhcp"
+	@echo "To view the help file:"
+	@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/JupyterQtConsole.qhc"
+
+applehelp:
+	$(SPHINXBUILD) -b applehelp $(ALLSPHINXOPTS) $(BUILDDIR)/applehelp
+	@echo
+	@echo "Build finished. The help book is in $(BUILDDIR)/applehelp."
+	@echo "N.B. You won't be able to view it unless you put it in" \
+	      "~/Library/Documentation/Help or install it in your application" \
+	      "bundle."
+
+devhelp:
+	$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
+	@echo
+	@echo "Build finished."
+	@echo "To view the help file:"
+	@echo "# mkdir -p $$HOME/.local/share/devhelp/JupyterQtConsole"
+	@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/JupyterQtConsole"
+	@echo "# devhelp"
+
+epub:
+	$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
+	@echo
+	@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
+
+latex:
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+	@echo
+	@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
+	@echo "Run \`make' in that directory to run these through (pdf)latex" \
+	      "(use \`make latexpdf' here to do that automatically)."
+
+latexpdf:
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+	@echo "Running LaTeX files through pdflatex..."
+	$(MAKE) -C $(BUILDDIR)/latex all-pdf
+	@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
+
+latexpdfja:
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+	@echo "Running LaTeX files through platex and dvipdfmx..."
+	$(MAKE) -C $(BUILDDIR)/latex all-pdf-ja
+	@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
+
+text:
+	$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
+	@echo
+	@echo "Build finished. The text files are in $(BUILDDIR)/text."
+
+man:
+	$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
+	@echo
+	@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
+
+texinfo:
+	$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
+	@echo
+	@echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
+	@echo "Run \`make' in that directory to run these through makeinfo" \
+	      "(use \`make info' here to do that automatically)."
+
+info:
+	$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
+	@echo "Running Texinfo files through makeinfo..."
+	make -C $(BUILDDIR)/texinfo info
+	@echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
+
+gettext:
+	$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
+	@echo
+	@echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
+
+changes:
+	$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
+	@echo
+	@echo "The overview file is in $(BUILDDIR)/changes."
+
+linkcheck:
+	$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
+	@echo
+	@echo "Link check complete; look for any errors in the above output " \
+	      "or in $(BUILDDIR)/linkcheck/output.txt."
+
+doctest:
+	$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
+	@echo "Testing of doctests in the sources finished, look at the " \
+	      "results in $(BUILDDIR)/doctest/output.txt."
+
+coverage:
+	$(SPHINXBUILD) -b coverage $(ALLSPHINXOPTS) $(BUILDDIR)/coverage
+	@echo "Testing of coverage in the sources finished, look at the " \
+	      "results in $(BUILDDIR)/coverage/python.txt."
+
+xml:
+	$(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml
+	@echo
+	@echo "Build finished. The XML files are in $(BUILDDIR)/xml."
+
+pseudoxml:
+	$(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml
+	@echo
+	@echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."
diff --git a/docs/autogen_config.py b/docs/autogen_config.py
new file mode 100755
index 0000000..56c88b4
--- /dev/null
+++ b/docs/autogen_config.py
@@ -0,0 +1,22 @@
+#!/usr/bin/env python
+
+import os.path
+from qtconsole.qtconsoleapp import JupyterQtConsoleApp
+
+header = """\
+Configuration options
+=====================
+
+These options can be set in ``~/.jupyter/jupyter_qtconsole_config.py``, or
+at the command line when you start it.
+"""
+
+destination = os.path.join(os.path.dirname(__file__), 'source/config_options.rst')
+
+def main():
+    with open(destination, 'w') as f:
+        f.write(header)
+        f.write(JupyterQtConsoleApp().document_config_options())
+
+if __name__ == '__main__':
+    main()
diff --git a/docs/conda-env.yml b/docs/conda-env.yml
new file mode 100644
index 0000000..0006585
--- /dev/null
+++ b/docs/conda-env.yml
@@ -0,0 +1,12 @@
+name: qtconsole_docs
+channels:
+- asmeurer
+dependencies:
+- ipykernel
+- numpydoc # we seem to not use that, but removing break readthedocs conda (for now)
+- pexpect
+- pygments
+- pyqt
+- pip:
+    - recommonmark # we seem to not use that, but removing break readthedocs conda (for now)
+    - readthedocs-sphinx-ext # we seem to not use that, but removing break readthedocs conda (for now)
diff --git a/docs/gh-pages.py b/docs/gh-pages.py
new file mode 100755
index 0000000..3480a2c
--- /dev/null
+++ b/docs/gh-pages.py
@@ -0,0 +1,136 @@
+#!/usr/bin/env python
+"""Script to commit the doc build outputs into the github-pages repo.
+
+Use:
+
+  gh-pages.py [tag]
+
+If no tag is given, the current output of 'git describe' is used.  If given,
+that is how the resulting directory will be named.
+
+In practice, you should use either actual clean tags from a current build or
+something like 'current' as a stable URL for the most current version of the """
+
+#-----------------------------------------------------------------------------
+# Imports
+#-----------------------------------------------------------------------------
+from __future__ import print_function
+
+import os
+import shutil
+import sys
+from os import chdir as cd
+from os.path import join as pjoin
+
+from subprocess import Popen, PIPE, CalledProcessError, check_call
+
+#-----------------------------------------------------------------------------
+# Globals
+#-----------------------------------------------------------------------------
+
+pages_dir = 'gh-pages'
+html_dir = 'build/html'
+pdf_dir = 'build/latex'
+pages_repo = 'git at github.com:jupyter/qtconsole.git'
+
+#-----------------------------------------------------------------------------
+# Functions
+#-----------------------------------------------------------------------------
+def sh(cmd):
+    """Execute command in a subshell, return status code."""
+    return check_call(cmd, shell=True)
+
+
+def sh2(cmd):
+    """Execute command in a subshell, return stdout.
+
+    Stderr is unbuffered from the subshell.x"""
+    p = Popen(cmd, stdout=PIPE, shell=True)
+    out = p.communicate()[0]
+    retcode = p.returncode
+    if retcode:
+        raise CalledProcessError(retcode, cmd)
+    else:
+        return out.rstrip()
+
+
+def sh3(cmd):
+    """Execute command in a subshell, return stdout, stderr
+
+    If anything appears in stderr, print it out to sys.stderr"""
+    p = Popen(cmd, stdout=PIPE, stderr=PIPE, shell=True)
+    out, err = p.communicate()
+    retcode = p.returncode
+    if retcode:
+        raise CalledProcessError(retcode, cmd)
+    else:
+        return out.rstrip(), err.rstrip()
+
+
+def init_repo(path):
+    """clone the gh-pages repo if we haven't already."""
+    sh("git clone %s %s"%(pages_repo, path))
+    here = os.getcwd()
+    cd(path)
+    sh('git checkout gh-pages')
+    cd(here)
+
+#-----------------------------------------------------------------------------
+# Script starts
+#-----------------------------------------------------------------------------
+if __name__ == '__main__':
+    # The tag can be given as a positional argument
+    try:
+        tag = sys.argv[1]
+    except IndexError:
+        tag = "dev"
+    
+    startdir = os.getcwd()
+    if not os.path.exists(pages_dir):
+        # init the repo
+        init_repo(pages_dir)
+    else:
+        # ensure up-to-date before operating
+        cd(pages_dir)
+        sh('git checkout gh-pages')
+        sh('git pull')
+        cd(startdir)
+
+    dest = pjoin(pages_dir, tag)
+
+    # don't `make html` here, because gh-pages already depends on html in Makefile
+    # sh('make html')
+    if tag != 'dev':
+        # only build pdf for non-dev targets
+        #sh2('make pdf')
+        pass
+
+    # This is pretty unforgiving: we unconditionally nuke the destination
+    # directory, and then copy the html tree in there
+    shutil.rmtree(dest, ignore_errors=True)
+    shutil.copytree(html_dir, dest)
+    if tag != 'dev':
+        #shutil.copy(pjoin(pdf_dir, 'ipython.pdf'), pjoin(dest, 'ipython.pdf'))
+        pass
+
+    try:
+        cd(pages_dir)
+        branch = sh2('git rev-parse --abbrev-ref HEAD').strip().decode('ascii', 'replace')
+        if branch != 'gh-pages':
+            e = 'On %r, git branch is %r, MUST be "gh-pages"' % (pages_dir,
+                                                                 branch)
+            raise RuntimeError(e)
+
+        sh('git add -A %s' % tag)
+        sh('git commit -m"Updated doc release: %s"' % tag)
+        print()
+        print('Most recent 3 commits:')
+        sys.stdout.flush()
+        # Need 3 commits in the repo before this will work
+        #sh('git --no-pager log --oneline HEAD~3..')
+    finally:
+        cd(startdir)
+
+    print()
+    print('Now verify the build in: %r' % dest)
+    print("If everything looks good, 'git push'")
diff --git a/docs/requirements.txt b/docs/requirements.txt
new file mode 100644
index 0000000..fcaec22
--- /dev/null
+++ b/docs/requirements.txt
@@ -0,0 +1,4 @@
+pygments
+-e git+https://github.com/jupyter/jupyter_client.git#egg=jupyter_client
+-e git+https://github.com/ipython/ipython.git#egg=ipython
+-e git+https://github.com/ipython/ipykernel.git#egg=ipykernel
diff --git a/docs/source/_images/qtconsole.png b/docs/source/_images/qtconsole.png
new file mode 100644
index 0000000..c6e3525
Binary files /dev/null and b/docs/source/_images/qtconsole.png differ
diff --git a/docs/source/changelog.rst b/docs/source/changelog.rst
new file mode 100644
index 0000000..c1eb6df
--- /dev/null
+++ b/docs/source/changelog.rst
@@ -0,0 +1,69 @@
+.. _changelog:
+
+Changes in Jupyter Qt console
+=============================
+
+.. _4.2:
+
+4.2.1
+-----
+
+`4.2.1 on GitHub <https://github.com/jupyter/qtconsole/milestones/4.2.1>`__
+
+Fix compatibility with some Qt bindings and traitlets ≥ 4.2.
+
+4.2
+---
+
+`4.2 on GitHub <https://github.com/jupyter/qtconsole/milestones/4.2>`__
+
+- various latex display fixes
+- improvements for embedding in Qt applications (use existing Qt API if one is already loaded)
+
+
+.. _4.1:
+
+4.1
+---
+
+.. _4.1.1:
+
+4.1.1
+-----
+
+`4.1.1 on GitHub <https://github.com/jupyter/qtconsole/milestones/4.1.1>`__
+
+- Set AppUserModelID for taskbar icon on Windows 7 and later
+
+.. _4.1.0:
+
+4.1.0
+~~~~~
+
+`4.1 on GitHub <https://github.com/jupyter/qtconsole/milestones/4.1>`__
+
+-  fix regressions in copy/paste, completion
+-  fix issues with inprocess IPython kernel
+-  fix ``jupyter qtconsole --generate-config``
+
+.. _4.0:
+
+4.0
+---
+
+.. _4.0.1:
+
+4.0.1
+~~~~~
+
+-  fix installation issues, including setuptools entrypoints for Windows
+-  Qt5 fixes
+
+.. _4.0.0:
+
+4.0.0
+~~~~~
+
+`4.0 on GitHub <https://github.com/jupyter/qtconsole/milestones/4.0>`__
+
+First release of the Qt console as a standalone package.
diff --git a/docs/source/conf.py b/docs/source/conf.py
new file mode 100644
index 0000000..a07ef2e
--- /dev/null
+++ b/docs/source/conf.py
@@ -0,0 +1,318 @@
+# -*- coding: utf-8 -*-
+#
+# Jupyter Qt Console documentation build configuration file, created by
+# sphinx-quickstart on Mon Apr 13 10:20:17 2015.
+#
+# This file is execfile()d with the current directory set to its
+# containing dir.
+#
+# Note that not all possible configuration values are present in this
+# autogenerated file.
+#
+# All configuration values have a default; values that are commented out
+# serve to show the default.
+
+
+# Check the version information
+release_info = {}
+exec(compile(open('../../qtconsole/_version.py').read(), '../../qtconsole/_version.py', 'exec'), release_info)
+
+import os
+if os.environ.get('READTHEDOCS', None) == 'True':
+    print('On RTD, regen API')
+    #from ..autogen_config import main
+    ns = {'__file__':'../autogen_config.py'}
+    exec(compile(open('../autogen_config.py').read(), '../autogen_config.py', 'exec'), ns )
+    ns['main']()
+
+
+# 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.
+#sys.path.insert(0, os.path.abspath('.'))
+
+# -- General configuration ------------------------------------------------
+
+# If your documentation needs a minimal Sphinx version, state it here.
+#needs_sphinx = '1.0'
+
+# 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.autodoc',
+    'sphinx.ext.autosummary',
+    'sphinx.ext.doctest',
+    'sphinx.ext.intersphinx',
+    'IPython.sphinxext.ipython_console_highlighting',
+]
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# The suffix(es) of source filenames.
+# You can specify multiple suffix as a list of string:
+# source_suffix = ['.rst', '.md']
+source_suffix = '.rst'
+
+# The encoding of source files.
+#source_encoding = 'utf-8-sig'
+
+# The master toctree document.
+master_doc = 'index'
+
+# General information about the project.
+project = 'Jupyter Qt Console'
+copyright = 'The Jupyter Development Team'
+author = 'The Jupyter Development Team'
+
+# numpydoc config
+numpydoc_show_class_members = False # Otherwise Sphinx emits thousands of warnings
+numpydoc_class_members_toctree = False
+
+# 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_info = release_info['version_info']
+
+version = ".".join([
+    str(version_info[0]),
+    str(version_info[1])
+])
+
+# The full version, including alpha/beta/rc tags.
+release = ".".join([
+    str(version_info[0]),
+    str(version_info[1]),
+    str(version_info[2])
+])
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#
+# This is also used if you do content translation via gettext catalogs.
+# Usually you set "language" from the command line for these cases.
+language = None
+
+# There are two options for replacing |today|: either, you set today to some
+# non-false value, then it is used:
+#today = ''
+# Else, today_fmt is used as the format for a strftime call.
+today_fmt = '%B %d, %Y'
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+exclude_patterns = []
+
+# The reST default role (used for this markup: `text`) to use for all
+# documents.
+default_role = 'literal'
+
+# If true, '()' will be appended to :func: etc. cross-reference text.
+#add_function_parentheses = True
+
+# If true, the current module name will be prepended to all description
+# unit titles (such as .. function::).
+#add_module_names = True
+
+# If true, sectionauthor and moduleauthor directives will be shown in the
+# output. They are ignored by default.
+#show_authors = False
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'sphinx'
+
+# A list of ignored prefixes for module index sorting.
+#modindex_common_prefix = []
+
+# If true, keep warnings as "system message" paragraphs in the built documents.
+#keep_warnings = False
+
+# If true, `todo` and `todoList` produce output, else they produce nothing.
+todo_include_todos = False
+
+
+# -- Options for HTML output ----------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+html_theme = 'sphinx_rtd_theme'
+
+# 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 = {}
+
+# Add any paths that contain custom themes here, relative to this directory.
+#html_theme_path = []
+
+# The name for this set of Sphinx documents.  If None, it defaults to
+# "<project> v<release> documentation".
+#html_title = None
+
+# A shorter title for the navigation bar.  Default is the same as html_title.
+#html_short_title = None
+
+# The name of an image file (relative to this directory) to place at the top
+# of the sidebar.
+#html_logo = None
+
+# The name of an image file (within the static path) to use as favicon of the
+# docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
+# pixels large.
+#html_favicon = None
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ['_static']
+
+# Add any extra paths that contain custom files (such as robots.txt or
+# .htaccess) here, relative to this directory. These files are copied
+# directly to the root of the documentation.
+#html_extra_path = []
+
+# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
+# using the given strftime format.
+#html_last_updated_fmt = '%b %d, %Y'
+
+# If true, SmartyPants will be used to convert quotes and dashes to
+# typographically correct entities.
+#html_use_smartypants = True
+
+# Custom sidebar templates, maps document names to template names.
+#html_sidebars = {}
+
+# Additional templates that should be rendered to pages, maps page names to
+# template names.
+#html_additional_pages = {}
+
+# If false, no module index is generated.
+#html_domain_indices = True
+
+# If false, no index is generated.
+#html_use_index = True
+
+# If true, the index is split into individual pages for each letter.
+#html_split_index = False
+
+# If true, links to the reST sources are added to the pages.
+#html_show_sourcelink = True
+
+# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
+#html_show_sphinx = True
+
+# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
+#html_show_copyright = True
+
+# If true, an OpenSearch description file will be output, and all pages will
+# contain a <link> tag referring to it.  The value of this option must be the
+# base URL from which the finished HTML is served.
+#html_use_opensearch = ''
+
+# This is the file name suffix for HTML files (e.g. ".xhtml").
+#html_file_suffix = None
+
+# Language to be used for generating the HTML full-text search index.
+# Sphinx supports the following languages:
+#   'da', 'de', 'en', 'es', 'fi', 'fr', 'hu', 'it', 'ja'
+#   'nl', 'no', 'pt', 'ro', 'ru', 'sv', 'tr'
+#html_search_language = 'en'
+
+# A dictionary with options for the search language support, empty by default.
+# Now only 'ja' uses this config value
+#html_search_options = {'type': 'default'}
+
+# The name of a javascript file (relative to the configuration directory) that
+# implements a search results scorer. If empty, the default will be used.
+#html_search_scorer = 'scorer.js'
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'JupyterQtConsoledoc'
+
+# -- Options for LaTeX output ---------------------------------------------
+
+latex_elements = {
+# The paper size ('letterpaper' or 'a4paper').
+#'papersize': 'letterpaper',
+
+# The font size ('10pt', '11pt' or '12pt').
+#'pointsize': '10pt',
+
+# Additional stuff for the LaTeX preamble.
+#'preamble': '',
+
+# Latex figure (float) alignment
+#'figure_align': 'htbp',
+}
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title,
+#  author, documentclass [howto, manual, or own class]).
+latex_documents = [
+  (master_doc, 'JupyterQtConsole.tex', u'Jupyter Qt Console Documentation',
+   u'Jupyter Development Team', 'manual'),
+]
+
+# The name of an image file (relative to this directory) to place at the top of
... 11712 lines suppressed ...

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/python-modules/packages/python-qtconsole.git



More information about the Python-modules-commits mailing list