Add changelog to docs and mention the docs in the changelog
This commit is contained in:
parent
45f08d0a32
commit
534cf4ef61
94
CHANGELOG.md
94
CHANGELOG.md
@ -1,9 +1,21 @@
|
||||
# v1.4.1
|
||||
## Changed
|
||||
# Changelog
|
||||
|
||||
A short, human-friendly (but technial !) description of each change made in
|
||||
each version
|
||||
|
||||
Format based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
|
||||
|
||||
I try to follow [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
|
||||
|
||||
## v1.4.1
|
||||
### Added
|
||||
- 🎉 jubeatools finally has proper online docs on readthedocs.io ! 🎉
|
||||
read them [here](https://jubeatools.readthedocs.io)
|
||||
### Changed
|
||||
- [memo2] The parser now displays much friendlier error messages when
|
||||
it finds uneven byte lengths in `#bpp=2` mode
|
||||
- Minimum required Python version is now 3.9
|
||||
## Fixed
|
||||
### Fixed
|
||||
- A fresh install of jubeatools would fail because of a API break in a
|
||||
transitive dependecy of `marshmallow-dataclass`, fixed by pin `typing-inspect`
|
||||
to `0.7.1`
|
||||
@ -16,8 +28,8 @@
|
||||
- [jubeat-analyser] Update the repository URL dumped in the comment at the top
|
||||
of the file
|
||||
|
||||
# v1.4.0
|
||||
## Added
|
||||
## v1.4.0
|
||||
### Added
|
||||
- [memon]
|
||||
- 🎉 inital support for v1.0.0 !
|
||||
- `--merge` option allows for several memon files to be merged when
|
||||
@ -26,7 +38,7 @@
|
||||
- [memon:v1.0.0]
|
||||
- [eve]
|
||||
- [jbsq]
|
||||
## Changed
|
||||
### Changed
|
||||
- Improved the merging procedure for song objects
|
||||
- Re-enable calling the CLI on a folder, this was disabled for some reason ?
|
||||
- The song class now uses a regular dict to map difficuty names to chart
|
||||
@ -34,73 +46,73 @@
|
||||
only format that *technically* supported this anyway, I conscider it an edge
|
||||
case not really worth handling)
|
||||
|
||||
# v1.3.0
|
||||
## Added
|
||||
## v1.3.0
|
||||
### Added
|
||||
- [memon] 🎉 v0.3.0 support
|
||||
|
||||
# v1.2.3
|
||||
## Fixed
|
||||
## v1.2.3
|
||||
### Fixed
|
||||
- Loaders and Dumpers would recieve options with unwanted default values when
|
||||
their corresponding flags were not passed to the commandline, resulting
|
||||
in weird bugs, not anymore ! #17
|
||||
|
||||
# v1.2.2
|
||||
## Changed
|
||||
## v1.2.2
|
||||
### Changed
|
||||
- Slashes in filenames are now ignored
|
||||
## Fixed
|
||||
### Fixed
|
||||
- Bug when using braces in output filenames
|
||||
- [malody] Dumping does not write placeholder `null` values anymore
|
||||
|
||||
# v1.2.1
|
||||
## Fixed
|
||||
## v1.2.1
|
||||
### Fixed
|
||||
- [malody] Parsing a file with keys that are unused for conversion
|
||||
(like `meta.mode_ext` or `extra`) would fire errors, not anymore !
|
||||
|
||||
# v1.2.0
|
||||
## Added
|
||||
## v1.2.0
|
||||
### Added
|
||||
- [malody] 🎉 initial malody support !
|
||||
|
||||
# v1.1.3
|
||||
## Fixed
|
||||
## v1.1.3
|
||||
### Fixed
|
||||
- [jubeat-analyser] All files are read and written in `surrogateescape` error
|
||||
mode to mimick the way jubeat analyser handles files at the byte level, without
|
||||
caring about whether the whole file can be properly decoded as shift-jis or not
|
||||
(Thanks Nomlas and Mintice for noticing this !)
|
||||
|
||||
# v1.1.2
|
||||
## Fixed
|
||||
## v1.1.2
|
||||
### Fixed
|
||||
- [jubeat-analyser]
|
||||
- Accept U+3000 (Ideographic space) as valid whitespace
|
||||
- [memo2]
|
||||
- Accept `t=` commands anywhere in the file
|
||||
- Accept `b=4` (and only 4) anywhere in the file
|
||||
|
||||
# v1.1.1
|
||||
## Fixed
|
||||
## v1.1.1
|
||||
### Fixed
|
||||
- `construct-typing` is now required for all builds
|
||||
|
||||
# v1.1.0
|
||||
## Added
|
||||
## v1.1.0
|
||||
### Added
|
||||
- [jbsq] 🎉 initial .jbsq support !
|
||||
|
||||
# v1.0.1
|
||||
## Fixed
|
||||
## v1.0.1
|
||||
### Fixed
|
||||
- Remove debug `print(locals())` mistakenly left in
|
||||
|
||||
# v1.0.0
|
||||
## Added
|
||||
## v1.0.0
|
||||
### Added
|
||||
- [eve]
|
||||
- 🎉 .eve support !
|
||||
- Add `--beat-snap={number}` loader option to allow aggressive rounding
|
||||
- Loaders can now take in arguments
|
||||
## Fixed
|
||||
### Fixed
|
||||
- Fix infinite loop that would occur when choosing a deduplicated filename
|
||||
- [jubeat-analyser] Prettier rendering of decimal values
|
||||
|
||||
# v0.2.0
|
||||
## Added
|
||||
## v0.2.0
|
||||
### Added
|
||||
- [mono-column] #circlefree mode accepts non-16ths notes and falls back to normal symbols when needed
|
||||
## Fixed
|
||||
### Fixed
|
||||
- [jubeat-analyser]
|
||||
- Raise exception earlier when a mono-column file is detected by the other #memo parsers (based on "--" separator lines)
|
||||
- [memo] [memo1]
|
||||
@ -114,22 +126,22 @@
|
||||
- Fix handling of paths-type values in metadata
|
||||
- Fix handling of charts with decimal level value
|
||||
|
||||
# v0.1.3
|
||||
## Changed
|
||||
## v0.1.3
|
||||
### Changed
|
||||
- [jubeat-analyser] Use "EXT" instead of "?" as the fallback difficulty name when loading
|
||||
## Fixed
|
||||
### Fixed
|
||||
- [memon] Fix TypeError that would occur when trying to convert
|
||||
- [memo2] Fix rendering missing blank lines between blocks, while technically still valid files, this made files rendered by jubeatools absolutely fugly and very NOT human friendly
|
||||
|
||||
# v0.1.2
|
||||
## Fixed
|
||||
## v0.1.2
|
||||
### Fixed
|
||||
- [jubeat-analyser]
|
||||
- Fix decimal -> fraction conversion to correctly handle numbers with only 3 decimal places #1
|
||||
- Remove Vs from the allowed extra symbols lists as it would clash with long note arrows
|
||||
|
||||
# v0.1.1
|
||||
## Fixed
|
||||
## v0.1.1
|
||||
### Fixed
|
||||
- [memo2] Loading a file that did not specify any offset (neither by `o=...`, `r=...` nor `[...]` commands) would trigger a TypeError, not anymore ! Offset now defaults to zero.
|
||||
|
||||
# v0.1.0
|
||||
## v0.1.0
|
||||
- Initial Release
|
2
docs/source/changelog.md
Normal file
2
docs/source/changelog.md
Normal file
@ -0,0 +1,2 @@
|
||||
```{include} ../../CHANGELOG.md
|
||||
```
|
@ -21,5 +21,6 @@ how to convert charts
|
||||
library/index
|
||||
cli
|
||||
api/index
|
||||
changelog.md
|
||||
```
|
||||
|
||||
|
Loading…
Reference in New Issue
Block a user