Bug#928913: unblock: elpy/1.28.0-2
Package: release.debian.org
Severity: normal
User: release.debian.org@packages.debian.org
Usertags: unblock
Please unblock package elpy
I'm filing this unblock request before uploading to unstable. This
proposed upload closes several documentation-related bugs, and
disables DH_VERBOSE. In particular, I believe these fixes are
valuable for developers with a Python background who are new to Emacs.
Closed bugs are:
#927084 elpa-elpy: README.Debian misleads users into enabling nonexistent Python 2 support
#927085 elpa-elpy: Please provide a QuickStart page
#928633 elpa-elpy: please provide docs in html format
I'm also considering adding a couple of lines to README.Debian apropos
how to configure a persistent Python shell pane, which is the familiar
and expected interface for devs coming from Eclipse+PyDev, Spyder,
PyCharm, Thonny, et al.
debdiff elpa-elpy_1.28.0-1_all.deb TO elpa-elpy_1.28.0-2_all.deb:
[The following lists of changes regard files as different if they have
different names, permissions or owners.]
Files in second .deb but not in first
-------------------------------------
-rw-r--r-- root/root /usr/share/doc/elpa-elpy/html/_sources/concepts.rst.txt
-rw-r--r-- root/root /usr/share/doc/elpa-elpy/html/_sources/editing.rst.txt
-rw-r--r-- root/root /usr/share/doc/elpa-elpy/html/_sources/extending.rst.txt
-rw-r--r-- root/root /usr/share/doc/elpa-elpy/html/_sources/ide.rst.txt
-rw-r--r-- root/root /usr/share/doc/elpa-elpy/html/_sources/index.rst.txt
-rw-r--r-- root/root /usr/share/doc/elpa-elpy/html/_sources/introduction.rst.txt
-rw-r--r-- root/root /usr/share/doc/elpa-elpy/html/_sources/quickstart.rst.txt
-rw-r--r-- root/root /usr/share/doc/elpa-elpy/html/_static/ajax-loader.gif
-rw-r--r-- root/root /usr/share/doc/elpa-elpy/html/_static/basic.css
-rw-r--r-- root/root /usr/share/doc/elpa-elpy/html/_static/classic.css
-rw-r--r-- root/root /usr/share/doc/elpa-elpy/html/_static/comment-bright.png
-rw-r--r-- root/root /usr/share/doc/elpa-elpy/html/_static/comment-close.png
-rw-r--r-- root/root /usr/share/doc/elpa-elpy/html/_static/comment.png
-rw-r--r-- root/root /usr/share/doc/elpa-elpy/html/_static/default.css
-rw-r--r-- root/root /usr/share/doc/elpa-elpy/html/_static/documentation_options.js
-rw-r--r-- root/root /usr/share/doc/elpa-elpy/html/_static/down-pressed.png
-rw-r--r-- root/root /usr/share/doc/elpa-elpy/html/_static/down.png
-rw-r--r-- root/root /usr/share/doc/elpa-elpy/html/_static/file.png
-rw-r--r-- root/root /usr/share/doc/elpa-elpy/html/_static/language_data.js
-rw-r--r-- root/root /usr/share/doc/elpa-elpy/html/_static/minus.png
-rw-r--r-- root/root /usr/share/doc/elpa-elpy/html/_static/plus.png
-rw-r--r-- root/root /usr/share/doc/elpa-elpy/html/_static/pygments.css
-rw-r--r-- root/root /usr/share/doc/elpa-elpy/html/_static/up-pressed.png
-rw-r--r-- root/root /usr/share/doc/elpa-elpy/html/_static/up.png
-rw-r--r-- root/root /usr/share/doc/elpa-elpy/html/concepts.html
-rw-r--r-- root/root /usr/share/doc/elpa-elpy/html/editing.html
-rw-r--r-- root/root /usr/share/doc/elpa-elpy/html/extending.html
-rw-r--r-- root/root /usr/share/doc/elpa-elpy/html/genindex.html
-rw-r--r-- root/root /usr/share/doc/elpa-elpy/html/ide.html
-rw-r--r-- root/root /usr/share/doc/elpa-elpy/html/index.html
-rw-r--r-- root/root /usr/share/doc/elpa-elpy/html/introduction.html
-rw-r--r-- root/root /usr/share/doc/elpa-elpy/html/objects.inv
-rw-r--r-- root/root /usr/share/doc/elpa-elpy/html/quickstart.html
-rw-r--r-- root/root /usr/share/doc/elpa-elpy/html/search.html
-rw-r--r-- root/root /usr/share/doc/elpa-elpy/html/searchindex.js
lrwxrwxrwx root/root /usr/share/doc/elpa-elpy/html/_static/doctools.js -> ../../../../javascript/sphinxdoc/1.0/doctools.js
lrwxrwxrwx root/root /usr/share/doc/elpa-elpy/html/_static/jquery.js -> ../../../../javascript/sphinxdoc/1.0/jquery.js
lrwxrwxrwx root/root /usr/share/doc/elpa-elpy/html/_static/searchtools.js -> ../../../../javascript/sphinxdoc/1.0/searchtools.js
lrwxrwxrwx root/root /usr/share/doc/elpa-elpy/html/_static/sidebar.js -> ../../../../javascript/sphinxdoc/1.0/sidebar.js
lrwxrwxrwx root/root /usr/share/doc/elpa-elpy/html/_static/underscore.js -> ../../../../javascript/sphinxdoc/1.0/underscore.js
Control files: lines which differ (wdiff format)
------------------------------------------------
Installed-Size: [-567-] {+815+}
Version: [-1.28.0-1-] {+1.28.0-2+}
--
debdiff elpy_1.28.0-1.dsc TO elpy_1.28.0-2.dsc:
diff -Nru elpy-1.28.0/debian/changelog elpy-1.28.0/debian/changelog
--- elpy-1.28.0/debian/changelog 2019-01-05 17:13:12.000000000 -0500
+++ elpy-1.28.0/debian/changelog 2019-04-17 19:13:51.000000000 -0400
@@ -1,3 +1,16 @@
+elpy (1.28.0-2) UNRELEASED; urgency=medium
+
+ * debian/rules: Disable DH_VERBOSE.
+ * Use sphinx to build and generate documentation in html format.
+ (Closes: #928633)
+ * debian/README.Debian: Make explicit how Debian's Elpy package does
+ not ship with support for Python 2. (Closes: #927084)
+ * debian/control: Clarify comment explaining why the Python 2 package
+ python-autopep8 is a build dependency.
+ * Add 0002-Add-quickstart-to-the-documentation.patch. (Closes: #927085)
+
+ -- Nicholas D Steeves <nsteeves@gmail.com> Wed, 17 Apr 2019 19:13:51 -0400
+
elpy (1.28.0-1) unstable; urgency=medium
* New upstream version.
diff -Nru elpy-1.28.0/debian/control elpy-1.28.0/debian/control
--- elpy-1.28.0/debian/control 2019-01-05 00:51:45.000000000 -0500
+++ elpy-1.28.0/debian/control 2019-04-17 19:13:51.000000000 -0400
@@ -21,7 +21,7 @@
, python3-jedi
, python3-autopep8 <!nocheck>
# python-autopep8 still seems to be needed for self-tests to pass.
-# See Bug #899212 for more information.
+# See the 1.21.0-1 debian/changelog entry on this topic for more info.
, python-autopep8 <!nocheck>
, yapf3
, python3-mock <!nocheck>
diff -Nru elpy-1.28.0/debian/docs elpy-1.28.0/debian/docs
--- elpy-1.28.0/debian/docs 2018-12-03 04:23:49.000000000 -0500
+++ elpy-1.28.0/debian/docs 2019-04-17 19:13:51.000000000 -0400
@@ -1 +1,2 @@
README.rst
+build/html
diff -Nru elpy-1.28.0/debian/patches/0002-Add-quickstart-to-the-documentation.patch elpy-1.28.0/debian/patches/0002-Add-quickstart-to-the-documentation.patch
--- elpy-1.28.0/debian/patches/0002-Add-quickstart-to-the-documentation.patch 1969-12-31 19:00:00.000000000 -0500
+++ elpy-1.28.0/debian/patches/0002-Add-quickstart-to-the-documentation.patch 2019-04-17 19:13:51.000000000 -0400
@@ -0,0 +1,50 @@
+From: galaunay <gaby.launay@tutanota.com>
+Date: Wed, 8 May 2019 22:42:52 +0100
+Subject: Add "quickstart" to the documentation
+Origin: https://github.com/jorgenschaefer/elpy/pull/1598
+
+---
+ docs/index.rst | 1 +
+ docs/quickstart.rst | 21 +++++++++++++++++++++
+ 2 files changed, 22 insertions(+)
+ create mode 100644 docs/quickstart.rst
+
+diff --git a/docs/index.rst b/docs/index.rst
+index 285c93f..6bb1f5e 100644
+--- a/docs/index.rst
++++ b/docs/index.rst
+@@ -10,6 +10,7 @@ Contents:
+ :maxdepth: 2
+
+ introduction
++ quickstart
+ concepts
+ editing
+ ide
+diff --git a/docs/quickstart.rst b/docs/quickstart.rst
+new file mode 100644
+index 0000000..175717b
+--- /dev/null
++++ b/docs/quickstart.rst
+@@ -0,0 +1,21 @@
++Quickstart
++==========
++
++Once installed, Elpy will automatically provide code completion, syntax error highlighting and function signature display (in the modeline) for python files.
++
++Useful keybindings
++------------------
++
++`C-c C-c` evaluates the current script (or region if something is selected) in an interactive python shell.
++
++`C-RET` evaluates the current statement (current line plus the following nested lines).
++
++`C-c C-z` switches between your script and the interactive shell.
++
++`C-c C-d` displays documentation for the thing under cursor (function or module). The documentation will pop in a different buffer, that can be closed with `q`.
++
++Go further
++----------
++
++Elpy provides a lot of features, including code navigation, debugging, testing, refactoring, profiling and support for virtual environments.
++Feel free to explore the documentation, everything is there !
diff -Nru elpy-1.28.0/debian/patches/series elpy-1.28.0/debian/patches/series
--- elpy-1.28.0/debian/patches/series 2018-12-03 04:23:49.000000000 -0500
+++ elpy-1.28.0/debian/patches/series 2019-04-17 19:13:51.000000000 -0400
@@ -1 +1,2 @@
0001-Disable-test-shell-send-region-or-buffer.patch
+0002-Add-quickstart-to-the-documentation.patch
diff -Nru elpy-1.28.0/debian/README.Debian elpy-1.28.0/debian/README.Debian
--- elpy-1.28.0/debian/README.Debian 2019-01-05 00:51:44.000000000 -0500
+++ elpy-1.28.0/debian/README.Debian 2019-04-17 19:13:51.000000000 -0400
@@ -1,38 +1,47 @@
Debian's Elpy package is configured to use the system-wide Python 3
-interpreter which will be supported after 1 January 2020, when Python 2
-will be EOL. The specific customisations are:
+interpreter and has never shipped with Python 2 support. See Bug
+#927086 for discussion.
-(setq elpy-rpc-pythonpath nil
- python-shell-interpreter "/usr/bin/python3"
- python-shell-interpreter-args "-i"
- elpy-rpc-python-command "/usr/bin/python3")
-
-Customise these variables to use Python interpreter, or reenable the
-normal rules of $PATH by dropping the absolute path. eg: Specify
-python3 and let $PATH choose python3 from something like
-~/.my_virtualenv2/bin/python3.
-
-Elpy's custom PYTHONPATH is not needed in packages that use dh-python,
-and has been unset. Previously Elpy unnecessarily searched
-site-lisp/elpa/elpy-1.23.0 for its associated Python modules.
+To run Elpy's checks for optional dependencies, from within Emacs:
+ M-x elpy-enable
+ M-x elpy-config
+
+To find the corresponding Debian packages, run this in a shell:
+ # apt show elpa-elpy | grep 'Recommends\|Suggests'
+
+Debian-specific customisations are found in elpa-elpy's
+debian-autoloads.el file.
+
+ # dpkg -L elpa-elpy | grep debian-autoloads.el
+
+If a virtualenv's python interpreter is not the same as the system
+one, then it might be necessary to reenable upstream behaviour. To do
+this, consult debian-autoloads.el, customise 'python-shell-interpreter'
+and 'elpy-rpc-python-command' on a per-user basis (eg: ~/.emacs,
+~/.emacs.el, or ~/.emacs.d/init.el), and drop the absolute path by
+setting these variables to "python3". Setting them to "python" in the
+hopes that this will reenable Python 2 support will not work, because
+the Elpy modules needed for Python 2 are neither built nor installed,
+and these modules are needed for the RPC Process (see documentation at
+Elpy->Concepts->The RPC Process) and various other functions. Also,
+elpa-elpy does not install a number of required Python 2 dependencies.
+
+Elpy's custom PYTHONPATH is not needed, because this package uses
+dh-python and has been unset. Previously Elpy unnecessarily searched
+/usr/share/emacs/site-lisp/site-lisp/elpa/elpy-1.23.0 for its
+Python modules.
+
+Upstream documentation for the installed Elpy version is available in
+info, html, and man page format at the standard locations. To access
+the info page:
+
+ # info elpy
+ # or: emacs --eval '(info "elpy")'
+ # or from within Emacs: M-x info, C-s elpy
An alternative interactive interpreter can be enabled by setting
-'python-shell-interpreter' and 'python-shell-interpreter-args' to (eg:
-Jupyter console or IPython). See "Interpreter Setup" section of
-Elpy's Documentation for more information.
-
-To restore upstream defaults, add the following to a user's Emacs config:
-
- (setq python-shell-interpreter "python"
- python-shell-interpreter-args "-i")
- elpy-rpc-python-command "python")
-
-These defaults are useful when moving between virtualenv projects
-where some projects use Python 3 and some projects use Python 2. That
-said, at present the Debian package is not built '--with python2' and
-so it is likely that Python 2 virtualenvs do not work correctly,
-because Python 2 modules are not built or installed to the system-wide
-PYTHONPATH. These modules are needed for the RPC Process. See
-Concepts->The RPC Process in 'info elpy' for further information.
+'python-shell-interpreter' and 'python-shell-interpreter-args' to
+something like Jupyter console or IPython. See the "Interpreter Setup"
+section of Elpy's Documentation for more information.
- -- Nicholas D Steeves <nsteeves@gmail.com>, Fri, 4 Jan 2019 22:41:43 -0700
+ -- Nicholas D Steeves <nsteeves@gmail.com>, Thu, 9 May 2019 18:21:45 -0400
diff -Nru elpy-1.28.0/debian/rules elpy-1.28.0/debian/rules
--- elpy-1.28.0/debian/rules 2018-12-03 04:23:49.000000000 -0500
+++ elpy-1.28.0/debian/rules 2019-04-17 19:13:51.000000000 -0400
@@ -1,6 +1,5 @@
#!/usr/bin/make -f
-export DH_VERBOSE = 1
export PYBUILD_NAME = elpy
LC_ALL := C.UTF-8
export LC_ALL
@@ -23,4 +22,5 @@
PYTHONPATH=. sphinx-build -N -bman docs/ build/man
PYTHONPATH=. sphinx-build -N -btexinfo docs/ build/info
makeinfo --no-split build/info/Elpy.texi -o build/info/elpy.info
+ PYTHONPATH=. sphinx-build -N -bhtml docs/ build/html
endif
--
The only changes to this diff are: 1) if upstream adds a fix to the
new QuickStart section, but I do not believe they will. 2) if I spot a
grammar/clarity issue of sufficient severity to fix. 3) that tip about
configuring a persistent Python shell pane. 4) obviously
s/UNRELEASED/unstable ;-)
QuickStart PR is here: https://github.com/jorgenschaefer/elpy/pull/1598
unblock elpy/1.28.0-2
Regards,
Nicholas
Reply to: