Skip to content

Commit

Permalink
docs: import changelog to main docs
Browse files Browse the repository at this point in the history
  • Loading branch information
jmcnamara committed Jun 18, 2024
1 parent a165202 commit 124961f
Show file tree
Hide file tree
Showing 5 changed files with 29 additions and 10 deletions.
26 changes: 20 additions & 6 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,24 @@
# Changelog

All notable changes to rust_xlsxwriter will be documented in this file.
All notable changes to `rust_xlsxwriter` will be documented in this file.

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

## [0.68.0] - 2023-06-18

### Added

- Added support for urls in images. [Feature Request #91].

[Feature Request #91]: https://github.com/jmcnamara/rust_xlsxwriter/issues/91

### Changed

- Changed the method signatures of the [`Image`] helper methods from `&mut
self` to `mut self` to allow method chaining. This is an API/ABI break.


## [0.67.0] - 2023-06-17

### Added
Expand Down Expand Up @@ -108,7 +122,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

- Added support for embedding images into worksheets with
[`worksheet::embed_image()`] and [`worksheet::embed_image_with_format()`] and
the [Image] struct. See the [Embedded Images] example.
the [`Image`] struct. See the [Embedded Images] example.

This can be useful if you are building up a spreadsheet of products with a
column of images for each product. Embedded images move with the cell so they
Expand Down Expand Up @@ -1093,7 +1107,7 @@ Added more page setup methods.

- Added support for inserting images into worksheets with
[`worksheet.insert_image()`] and [`worksheet.insert_image_with_offset()`] and
the [Image] struct.
the [`Image`] struct.

See also the [images example] in the user guide.

Expand All @@ -1106,7 +1120,7 @@ Added more page setup methods.
- The [`workbook.save()`] method has been extended to handle paths or strings.
The `workbook.save_to_path()` method has been removed. See [PR #15].

[Image]: https://docs.rs/rust_xlsxwriter/latest/rust_xlsxwriter/struct.Format.html
[`Image`]: https://docs.rs/rust_xlsxwriter/latest/rust_xlsxwriter/struct.Format.html
[PR #15]: https://github.com/jmcnamara/rust_xlsxwriter/pull/15
[images example]: https://rustxlsxwriter.github.io/examples/images.html
[`worksheet.insert_image()`]: https://docs.rs/rust_xlsxwriter/latest/rust_xlsxwriter/struct.Worksheet.html#method.insert_image
Expand Down Expand Up @@ -1322,7 +1336,7 @@ restructures the Workbook constructor/destructor sequence and introduces a
- [`worksheet.set_footer()`]
- [`worksheet.set_margins()`]

See also the rust_xlsxwriter user documentation on [Adding Headers and
See also the `rust_xlsxwriter` user documentation on [Adding Headers and
Footers].

[`worksheet.set_header()`]: https://docs.rs/rust_xlsxwriter/latest/rust_xlsxwriter/struct.Worksheet.html#method.set_header
Expand Down Expand Up @@ -1358,7 +1372,7 @@ restructures the Workbook constructor/destructor sequence and introduces a
[`worksheet.write_array()`] and
[`worksheet.write_dynamic_array_formula_with_format()`].

See also the rust_xlsxwriter user documentation on [Dynamic Array support].
See also the `rust_xlsxwriter` user documentation on [Dynamic Array support].

[`worksheet.write_array()`]: https://docs.rs/rust_xlsxwriter/latest/rust_xlsxwriter/struct.Worksheet.html#method.write_array_formula
[`worksheet.write_dynamic_array_formula_with_format()`]: https://docs.rs/rust_xlsxwriter/latest/rust_xlsxwriter/struct.Worksheet.html#method.write_dynamic_array_formula
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -157,5 +157,5 @@ See the full [Release Notes and Changelog].
[The rust_xlsxwriter crate]: https://crates.io/crates/rust_xlsxwriter
[The rust_xlsxwriter API docs at docs.rs]: https://docs.rs/rust_xlsxwriter/latest/rust_xlsxwriter/
[The rust_xlsxwriter repository]: https://github.com/jmcnamara/rust_xlsxwriter
[Release Notes and Changelog]: https://rustxlsxwriter.github.io/changelog.html
[Release Notes and Changelog]: https://docs.rs/rust_xlsxwriter/latest/rust_xlsxwriter/changelog/index.html
[Roadmap of planned features]: https://github.com/jmcnamara/rust_xlsxwriter/issues/1
1 change: 1 addition & 0 deletions src/changelog.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
#![doc = include_str!("../CHANGELOG.md")]
8 changes: 6 additions & 2 deletions src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,8 @@
//! creating and using charts.
//! </p>
//!
//! <p>
//!
//! - [`Format`]: The interface for adding formatting to worksheets and other
//! objects.
//! - [`Table`]: The interface for worksheet tables.
Expand All @@ -78,15 +80,16 @@
//! - [`Url`]: A type for URLs/Hyperlinks used in worksheets.
//! - [`DocProperties`]: The interface used to create an object to represent
//! document metadata properties.
//! </p>
//!
//! - [`Changelog`](crate::changelog): Release notes and changelog.
//!
//! Other external documentation:
//!
//! - [User Guide]: Working with the `rust_xlsxwriter` library.
//! - [Release Notes].
//! - [Roadmap of planned features].
//!
//! [User Guide]: https://rustxlsxwriter.github.io/index.html
//! [Release Notes]: https://rustxlsxwriter.github.io/changelog.html
//! [Roadmap of planned features]:
//! https://github.com/jmcnamara/rust_xlsxwriter/issues/1
//!
Expand Down Expand Up @@ -217,6 +220,7 @@ pub mod conditional_format;
pub mod cookbook;
pub mod sparkline;
pub mod tutorial;
pub mod changelog;
pub mod utility;
pub mod workbook;
pub mod worksheet;
Expand Down
2 changes: 1 addition & 1 deletion src/tutorial.rs
Original file line number Diff line number Diff line change
Expand Up @@ -742,8 +742,8 @@ following resources for more information:
- [Release Notes].
- [Roadmap of planned features].
[Release Notes]: crate::changelog
[User Guide]: https://rustxlsxwriter.github.io/index.html
[Release Notes]: https://rustxlsxwriter.github.io/changelog.html
[Roadmap of planned features]:
https://github.com/jmcnamara/rust_xlsxwriter/issues/1
Expand Down

0 comments on commit 124961f

Please sign in to comment.