Skip to content

Commit d1839d8

Browse files
committed
Modify changelog from md to rst
1 parent d4c4d5e commit d1839d8

File tree

3 files changed

+19
-12
lines changed

3 files changed

+19
-12
lines changed
Lines changed: 17 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,36 @@
1-
# Changelog
1+
Changelog
2+
=========
23

34
All notable changes to this project will be documented in this file.
45

56
The format is based on [Keep a Changelog](https://keepachangelog.com/en),
67
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
78

8-
## [Unreleased]
9-
10-
### Added
9+
[Unreleased]
10+
------------
11+
Added
12+
^^^^^
1113
- Add an implementation of visvalingam algorithm to simplify polygons with low modification
1214
- Add method to found close tracks in an other atlas
1315
- Allow to give a x reference when we display grid to be able to change xlim
1416
- Add option to EddyId to select data index like `--indexs time=5 depth=2`
1517
- Add a method to merge several indexs type for eddy obs
16-
- Acces at dataset variable like attribute, and lifetime/age are available for all observations
18+
- Get dataset variable like attribute, and lifetime/age are available for all observations
1719
- Add **EddyInfos** application to get general information about eddies dataset
1820
- Add method to inspect contour rejection (which are not in eddies)
19-
- Grid interp could be "nearest" or "bilinear"
20-
### Changed
21-
- Now to have object informations in plot label used python ```fomat``` style, several key are available :
21+
- Grid interp could be "nearest" or "bilinear"
22+
23+
Changed
24+
^^^^^^^
25+
- Now to have object informations in plot label used python ```format``` style, several key are available :
26+
2227
- "t0"
2328
- "t1"
2429
- "nb_obs"
2530
- "nb_tracks" (only for tracked eddies)
26-
### Removed
27-
2831

29-
## [3.2.0] - 2020-09-16
32+
[3.2.0] - 2020-09-16
33+
--------------------
3034

31-
## [3.1.0] - 2020-06-25
35+
[3.1.0] - 2020-06-25
36+
--------------------

doc/changelog.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
.. include:: ../CHANGELOG.rst

doc/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,7 @@ Welcome to py-eddy-tracker's documentation!
4040

4141
api
4242
Source (Git) <https://github.com/AntSimi/py-eddy-tracker>
43+
changelog
4344

4445

4546
Indices and tables

0 commit comments

Comments
 (0)