rougail-output-doc/CHANGELOG.md

149 lines
4.4 KiB
Markdown
Raw Normal View History

2026-06-21 18:23:40 +02:00
## 1.0.0 (2026-06-21)
2026-06-21 14:42:58 +02:00
### Feat
- better ansible documentation
2026-06-11 08:07:17 +02:00
- leadership => sequence
2026-06-21 18:23:40 +02:00
- add dot if needed
- better documentation generation
- support transitive
- doc transitive properties
- add 'document_a_type' option
- remove doc.root, pass directly the family to doc output (be careful, add true_config parameter too)
- personalise column number
- document commandline and environment variable
- change path in description
- add anchor to markdown format and remove unsupported character in anchor id
- use blockquote for family description
- better enter support
- delete/underline is inside tag for some format
- can reload formatter
- can document part by part with reloading structure
- anchor in gitlab output_format
- can had comments with family/variable description in examples doc
- comment variables from a family
- tags documentation
- ca force true_color terminal when export to console
- can document a variable for a specified identifier
- can remove header when generate a table
- add html output
- changelog for variables
- limit warning when asked
- better support variable calculation for property
- add gitlab plugin
- default value for a calculated variable with an unknown optional variable
- add integer type which will replace number type
- adapt to tiramisu-web-ui
- could not change default value during annotator
- document unix file name parameters
- better console output
- do not document reference to undocumented variable
- add with_family parameter
- output return status too
- create tests
- personalize mode that we want disable documentation
- add console output
- better dynamique family support
- add json output
2026-06-11 08:07:17 +02:00
### Fix
2026-06-21 18:23:40 +02:00
- rougail dependencies
- black
- tests
- update tests
2026-06-11 08:07:17 +02:00
- test example with mode
2026-05-06 11:25:41 +02:00
- example for partial documentation
2026-05-04 13:35:08 +02:00
- get unrestraint default value
2026-04-30 07:32:53 +02:00
- better identifier documentation
- better display of path
- better description informations
- do not display {{ identifier }} in description
- better identifier support
- support mode
- root config with identifier
2026-01-29 08:40:07 +01:00
- better transitive documentation
- update translation
2026-01-21 09:00:38 +01:00
- root could be a variable
- path
2026-01-14 15:37:56 +01:00
- yaml in output format do not convert object to str
2025-12-30 10:53:04 +01:00
- update tests
- read_write is a boolean
2025-12-22 08:56:14 +01:00
- better documentation
- better commandline doc + params description is now in rougail
2025-11-21 08:15:09 +01:00
- dynamic variables with identifier in description
- gitlab id in anchor with dynamic variables
2025-10-27 14:25:26 +01:00
- add changelog support for github/gitlab format
- tests
2025-10-22 17:02:38 +02:00
- parse subtree for a dynamic
- adapt api for rougail-web-ui
- undocumented variable in dynamic
2025-10-16 08:21:49 +02:00
- support rougail-web-ui
- black
- remove extra '*'
- always use name for informations key (sometime path was used)
- update tests
- translation for property is now in rougail
2025-10-03 08:22:36 +02:00
- property calculated with disabled variable
- better disabled support
2025-10-02 08:38:48 +02:00
- property for namespace
2025-10-02 08:19:30 +02:00
- tests for formatter
- update translation
2025-09-29 21:26:25 +02:00
- doc network with CIDR format
- better doc for calculation with unknown variable
2025-06-18 15:52:35 +02:00
- separation
2025-06-18 06:57:53 +02:00
- rougail separation
2025-05-12 09:11:19 +02:00
- update translation
- black
- doc example with leader example lower than leader default value
2025-05-09 08:22:34 +02:00
- undefined is a rougail object
2025-05-05 10:08:56 +02:00
- update translation
2025-05-05 10:03:59 +02:00
- doc default value with undocumented variable
2025-05-05 08:52:28 +02:00
- description for all calculations
- better documentation variable with variable in default attribut
2025-04-30 09:04:41 +02:00
- update translation
- remove negative_description support
- better documentation with hidden variable in property calculation
- use new information ymlfiles
- update tests
- better dynamic support
2025-04-09 21:34:24 +02:00
- version
2025-04-07 08:42:04 +02:00
- calculation for dynamic ans leadership variables
2025-04-02 21:16:40 +02:00
- error in disabled dynamic variable
2025-04-01 22:19:42 +02:00
- update tests
- groups.namespace could be unexistant
2025-03-31 10:25:17 +02:00
- doc a param with a set but with only one item
2025-03-30 19:48:00 +02:00
- doc for param
- support NamespaceCalculation
- convert <ENV> to &lt;ENV&gt; for github plugin
2025-02-19 16:43:55 +01:00
- support suffix (in version 1.0 format) in calculation
2025-02-19 12:49:32 +01:00
- key is the path
2025-02-19 08:39:59 +01:00
- with_family => without_family and with_example => example
2025-02-17 09:49:59 +01:00
- do not add multiple attribute several time in json export
2025-01-04 18:00:49 +01:00
- detect_symlink => only_self
2025-01-04 11:55:02 +01:00
- do not document symlink
- remove prefix_path
2024-11-28 21:37:17 +01:00
- separation between run and print function
2024-11-20 22:01:04 +01:00
- correction for properties in italic
2026-06-21 18:23:40 +02:00
- generate documentation with force_optional configuration
2024-11-20 22:01:04 +01:00
2026-06-21 18:23:40 +02:00
### Refactor
2024-11-08 08:14:35 +01:00
2026-06-21 18:23:40 +02:00
- **locale-po**: locale translation
- **typo**: french translation type
2024-11-08 08:14:35 +01:00
## 0.1.0 (2024-11-06)
2024-11-06 17:40:57 +01:00
## 0.1.0rc1 (2024-11-06)
### Fix
- support variable dynamic with test as values
- update rougail dependency
2024-11-01 11:45:56 +01:00
## 0.1.0rc0 (2024-11-01)
### Feat
- black + improvement