v0.6.1

Changelog

[0.6.1] - 2024-05-06

Bug Fixes

• Final section for module.item not included (#26) (@Tired-Fox)
• # rhai-autodocs:index:x is not longer mistaken for a documentation section anymore (#28) (@ltabis)
• Add a border to mdbook item frames to make the distinction between them more visible (#25) (@Tired-Fox)
• Code block at end of sections breaking markdown (#27) (@Tired-Fox)

Miscellaneous Tasks

• Update mdbook example
• Bump docusaurus to 3.3.2
• Release rhai-autodocs version 0.6.1

Thank you @Tired-Fox for the contributions!

v0.6.0

Changelog

[0.6.0] - 2024-05-02

This is a breaking release, most of the API to export and generate documentation as been reworked using the builder pattern. See the README for examples.

Features

• [breaking] Add builder pattern for exporting and generating documentation (#15)
• [breaking] Add links to item documentation in the glossary definitions (#19)
• [breaking] Rename root module, do not generate docs for empty modules (#21)

Refactor

• [breaking] Hide items that are not supposed to appear in the API (#16)
• [breaking] Remove all re-exports
• [breaking] Replace build function by generate in the generate module

Miscellaneous Tasks

• Release rhai-autodocs version 0.6.0

v0.5.4

Changelog

[0.5.4] - 2024-04-26

Fix

• # was used as documentation sections even when declared in code blocks (#14)
• Some Result types where left in the docs or would be not formatted correctly (#14)

v0.5.3

Changelog

[0.5.3] - 2024-04-22

Bug Fixes

• Ignore unindexed documentation for functions

Miscellaneous Tasks

• Release rhai-autodocs version 0.5.3

v0.5.2

Changelog

[0.5.2] - 2024-04-22

Documentation

• Update readme

Miscellaneous Tasks

• Release rhai-autodocs version 0.5.2

Refactor

• Remove autodocs:ignore, simply ignore docs without autodocs:index

v0.5.1

Changelog

[0.5.1] - 2024-04-18

Documentation

• Add ignore to readme

Feat

• Ignore items documentation with the # rhai-autodocs:ignore preprocessor (#13)

Miscellaneous Tasks

• Release rhai-autodocs version 0.5.1

v0.5.0

Changelog

[0.5.0] - 2024-04-12

Documentation

• Update readme with up to date examples

Features

• Group get/set and indexget/set
• Add Object.Type name for getter, setters and indexes
• Update docusaurus generation to support v3

Miscellaneous Tasks

• Update docusaurus example dependencies
• Update docusaurus function signature
• Add custom types example documentation generation
• Bump rhai to 1.18
• Fix docusaurus example typos

Refactor

• Template generation using handlebar

Testing

• Update item order test

Wip

• Update mdbook examples and add generation function from handlebar

v0.4.3

Changelog

[0.4.3] - 2024-02-05

Miscellaneous Tasks

• Bump rhai to 1.17.1
• Release rhai-autodocs version 0.4.3

v0.4.2

Changelog

[0.4.2] - 2024-01-31

Miscellaneous Tasks

• Update serde and docusaurus example dependencies
• Bump serde
• Bump rhai to 1.70
• Release rhai-autodocs version 0.4.2

v0.4.1

Changelog

[0.4.1] - 2023-11-01

Miscellaneous Tasks

• Bump dependencies