summaryrefslogtreecommitdiff
path: root/CHANGELOG.md
blob: 95e9b27c68b63b95243432d7cb82abfa4c85ffd7 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
# Change log

pandoc-pyplot uses [Semantic Versioning](http://semver.org/spec/v2.0.0.html)

Release 2.3.0.0
---------------

* Added support for pandoc 2.8 and pandoc-types 1.20 (fixes #9). Because of breaking changes in pandoc-types 1.20, pandoc-pyplot 2.3.0.0+ only supports pandoc 2.8+. 

Release 2.2.0.0
---------------

* Added support for rendering figures via the Plotly library.

Release 2.1.5.1
---------------

* Fixed an issue where setting the configuration option `transparent: true`  left high-resolution figures difficult to see. Therefore, the option `transparent: true` does not affect high-resolution figures anymore.

Release 2.1.5.0
---------------

* Added support for two new configuration values: `tight_bbox: true|false` and `transparent: true|false`. These values are only supported via configuration files `.pandoc-pyplot.yml`.

Release 2.1.4.0
---------------

* Added examples and documentation on how to use `pandoc-pyplot` on LaTeX documents.
* Allowed raw LaTeX macros in figure captions. This is required to label figures in LaTeX. E.g.:
  
  ```latex
  \begin{minted}[caption=myCaption\label{myfig}]{pyplot}
  
  \end{minted}
  ```

* `with-links` key changed to `links`. I'm sorry. Pandoc doesn't support LaTeX tokens with `-`.

Release 2.1.3.0
---------------

* Switched to using [optparse-applicative](https://github.com/pcapriotti/optparse-applicative#arguments) for command-line argument parsing.
* Added a command-line options, "--write-example-config", which will write a config file ".pandoc-pyplot.yml" to show all available configuration options.
* Links to source code and high-res images can be suppressed using `{.pyplot with-links=false ...}` (or via the configuration file with `with-links: false`). This is to get cleaner output in technical documentation (e.g. PDF). Example:

  ```markdown
    ```{.pyplot caption="This is a caption" with-links=false}
    import matplotlib.pyplot as plt
    plt.figure()
    plt.plot([1,2,3,4,5],[1,2,3,4,5])
    ```
  ```
* Added automated builds on macOS and Linux via Azure-Pipelines. Windows build will stay on Appveyor for now.

Release 2.1.2.0
---------------

* Added the "flags" configuration option, which allows to pass command-line flags to the Python interpreter. For example, warnings can be suppressed using the `-Wignore` flag.
* Refactoring of the script check mechanism. It will be much easier to extend in the future.
* Updated the command-line help with an example combining pandoc-pyplot and pandoc-crossref
* Default Python interpreter is now "python" on Windows and __"python3" otherwise__.

Release 2.1.1.1
---------------

* Fixed a critical bug where pandoc-pyplot would interpret input from pandoc as a malformed command-line flag.

Release 2.1.1.0
---------------

* Added a command-line option to open the HTML manual in the default web browser.
* Added documentation regarding compatibility with pandoc-crossref. This was always supported but not explicitly documented.

Release 2.1.0.1
---------------

* Fixed outdated documentation (referencing "target" parameter)
* Fixed types required to build Configuration values that were not exported (SaveFormat, PythonScript)

Release 2.1.0.0
---------------

* Added support for config files ".pandoc-pyplot.yml", which specify different default values. This is mirrored in the new `Configuration` type and new functions, `makePlotWithConfig` and `plotTransformWithConfig`.
* Added the ability to specify a different Python interpreter to use.
* Added support for GIF and TIF files.
* Added the "-f"/"--formats" command to show supported output figure formats.
* Added support for GHC 8.2
* Moved internal modules to `Text.Pandoc.Filter.Pyplot.Internal` module.

Release 2.0.1.0
---------------

* Support for Markdown formatting in figure captions, including LaTeX math.

Release 2.0.0.0
---------------

Many **breaking changes** in this release:

* `pandoc-pyplot` will now determine the filename based on hashing the figure content. Therefore, figures will only be re-generated if necessary.
* Removed the ability to control the filename and format directly using the `plot_target=...` attribute.
* Added the ability to control the directory in which figures will be saved using the `directory=...` attribute.
* Added the possibility to control the figures dots-per-inch (i.e. pixel density) with the `dpi=...` attribute.
* Added the ability to control the figure format with the `format=...` attribute. Possible values are currently `"png"`, `"svg"`, `"pdf"`, `"jpg"`/`"jpeg"` and `"eps"`.
* The confusing `plot_alt=...` attribute has been renamed to `caption=...` for obvious reasons.
* The `plot_include=...` attribute has been renamed to `include=...`.
* Added the generation of a higher resolution figure for every figure `pandoc-pyplot` understands.

Release 1.1.0.0
---------------

* Added the ability to include Python files before code using the `plot_include=script.py` attribute.
* Added a test suite.

Release 1.0.3.0
---------------

* Fixed an issue where `pandoc-pyplot` would not build with base < 4.9 (#1)

Release 1.0.2.0
---------------

* Added support for captions using the `plot_alt=...` attribute. For example:

  ```markdown
    ```{plot_target=test.png plot_alt="This is a caption"}
    import matplotlib.pyplot as plt
    plt.figure()
    plt.plot([1,2,3,4,5],[1,2,3,4,5])
    ```
  ```

Release 1.0.1.0
---------------

* Added `plotTransform :: Pandoc -> IO Pandoc` function to transform entire documents. This makes it easier to integrate `pandoc-pyplot` into Hakyll-based sites!

Release 1.0.0.1
---------------

* Updated README with fixes and warnings
* Added top-level package documentation compatible with Haddock
* Added Unsafe language extension, as this filter will run arbitrary Python scripts.

Release 1.0.0.0
---------------

Initial release.

See documentation on [Hackage](https://hackage.haskell.org/package/pandoc-pyplot)