You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.rst
+34-8Lines changed: 34 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -9,7 +9,7 @@
9
9
10
10
:Author: Geoffrey Poore
11
11
12
-
:Version: 0.11beta
12
+
:Version: 0.11
13
13
14
14
:License:LPPL_ (LaTeX code) and `BSD 3-Clause`_ (Python code)
15
15
@@ -20,25 +20,51 @@
20
20
21
21
PythonTeX provides fast, user-friendly access to Python from within LaTeX. It allows Python code entered within a LaTeX document to be executed, and the results to be included within the original document. It also provides syntax highlighting for code within LaTeX documents via the Pygments syntax highlighter.
22
22
23
-
See ``pythontex.pdf`` for installation instructions. See ``pythontex_gallery.pdf`` for examples of what is possible with PythonTeX.
23
+
See ``pythontex.pdf`` for detailed installation instructions, or use the installation script for TeX Live. See ``pythontex_quickstart.pdf`` to get started, and ``pythontex_gallery.pdf`` for examples of what is possible with PythonTeX.
24
24
25
25
The ``depythontex`` utility creates a copy of a PythonTeX document in which all Python code has been replaced by its output. This plain LaTeX document is more suitable for journal submission, sharing, or conversion to other document formats. See ``pythontex_gallery.html`` and the accompanying conversion script for an example of a PythonTeX document that was converted to HTML via ``depythontex`` and `Pandoc <http://johnmacfarlane.net/pandoc/>`_.
26
26
27
27
28
-
Current status (2013/04/03)
29
-
---------------------------
28
+
Current status
29
+
--------------
30
30
31
-
A thorough review of all current and planned features has just been completed. This clears the way for a full release as soon as a few modifications are made . The goal is to freeze all syntax and command names after the full release, so ensuring their compatibility with planned features is important.
31
+
Immediate development goals:
32
32
33
-
Upcoming development will focus on refactoring. This has two goals:
33
+
* Create a simple system for adding support for additional programming languages beyond Python. Add basic support for at least one additional language as proof-of-concept.
34
+
* Improve treatment of stderr, so that UserWarnings generated by packages may be processed correctly.
34
35
35
-
* Better support for macro programming with PythonTeX.
36
-
* Creating a simple system for adding support for additional programming languages beyond Python.
36
+
37
+
Upcoming objectives:
38
+
39
+
* Add better support for macro programming with PythonTeX.
37
40
38
41
39
42
Version History
40
43
---------------
41
44
45
+
v0.11 (2013/04/21)
46
+
47
+
* As the first non-beta release, this version adds several features and introduces several changes. You should read these release notes carefully, since some changes are not backwards-compatible. Changes are based on a thorough review of all current and planned features. PythonTeX's capabilities have already grown beyond what was originally intended, and a long list of features still remains to be implemented. As a result, some changes are needed to ensure consistent syntax and naming in the future. Insofar as possible, all command names and syntax will be frozen after this release.
48
+
* Added the ``pythontex.py`` and ``depythontex.py`` wrapper scripts. When run, these detect the current version of Python and import the correct PythonTeX code. It is still possible to run ``pythontex*.py`` and ``depythontex*.py`` directly, but the new wrapper scripts should be used instead for simplicity. There is now only a single ``pythontex_utils.py``, which works with both Python 2 and Python 3.
49
+
* Added the ``beta`` package option. This makes the current version behave like v0.11beta, for compatibility. This option is temporary and will probably only be retained for a few releases.
50
+
* Backward-incompatible changes (require the ``beta`` option to restore old behavior)
51
+
52
+
- The ``pyverb`` environment has been renamed ``pyverbatim``. The old name was intended to be concise, but promoted confusion with LaTeX's ``\verb`` macro.
53
+
- For ``\printpythontex``, ``\stdoutpythontex``, and ``\stderrpythontex``, the modes ``inlineverb`` and ``v`` have been replaced by ``verb``, and the old mode ``verb`` has been replaced by ``verbatim``. This brings naming conventions in line with standard LaTeX ``\verb`` and ``verbatim``, avoiding a source of potential confusion.
54
+
- The ``\setpythontexpyglexer``, ``\setpythontexpygopt``, and ``\setpygmentspygopt`` commands now take an optional argument and a mandatory argument, rather than two mandatory arguments. This creates better uniformity among current and planned settings macros.
55
+
- The ``\setpythontexformatter`` and ``\setpygmentsformatter`` commands have been replaced by the ``\setpythontexprettyprinter`` and ``\setpygmentsprettyprinter`` commands. This anticipates possible upcoming features. It also avoids potential confusion with Pygments's formatters and the utilities class's ``formatter()`` method.
56
+
57
+
* Deprecated (still work, but raise warnings; after a few releases, they will raise errors instead, and after that eventually be removed)
58
+
59
+
- The ``rerun`` setting ``all`` was renamed ``always``, in preparation for upcoming features.
60
+
- The ``stderr`` option is replaced by ``makestderr``. The ``print``/``stdout`` option is replaced by ``debug``. These are intended to prevent confusion with future features.
61
+
- The ``fixlr`` option is deprecated. It was originally introduced to deal with some of SymPy's LaTeX formatting, which has since changed.
62
+
- The utilities class method ``init_sympy_latex()`` is deprecated. The ``sympy_latex()`` and ``set_sympy_latex()`` methods now automatically initialize themselves on first use.
63
+
64
+
* Added ``autostdout`` package option and ``\setpythontexautostdout``, to complement ``autoprint``. Added ``prettyprinter`` and ``prettyprintinline`` package options to complement new settings commands.
65
+
* Added quickstart guide.
66
+
* Installer now installs gallery and quickstart files, if present.
0 commit comments