rougail-output-doc/CHANGELOG.md

1.0.0 (2026-06-21)

Feat

• better ansible documentation
• leadership => sequence
• 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

Fix

• rougail dependencies
• black
• tests
• update tests
• test example with mode
• example for partial documentation
• get unrestraint default value
• 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
• better transitive documentation
• update translation
• root could be a variable
• path
• yaml in output format do not convert object to str
• update tests
• read_write is a boolean
• better documentation
• better commandline doc + params description is now in rougail
• dynamic variables with identifier in description
• gitlab id in anchor with dynamic variables
• add changelog support for github/gitlab format
• tests
• parse subtree for a dynamic
• adapt api for rougail-web-ui
• undocumented variable in dynamic
• 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
• property calculated with disabled variable
• better disabled support
• property for namespace
• tests for formatter
• update translation
• doc network with CIDR format
• better doc for calculation with unknown variable
• separation
• rougail separation
• update translation
• black
• doc example with leader example lower than leader default value
• undefined is a rougail object
• update translation
• doc default value with undocumented variable
• description for all calculations
• better documentation variable with variable in default attribut
• update translation
• remove negative_description support
• better documentation with hidden variable in property calculation
• use new information ymlfiles
• update tests
• better dynamic support
• version
• calculation for dynamic ans leadership variables
• error in disabled dynamic variable
• update tests
• groups.namespace could be unexistant
• doc a param with a set but with only one item
• doc for param
• support NamespaceCalculation
• convert to <ENV> for github plugin
• support suffix (in version 1.0 format) in calculation
• key is the path
• with_family => without_family and with_example => example
• do not add multiple attribute several time in json export
• detect_symlink => only_self
• do not document symlink
• remove prefix_path
• separation between run and print function
• correction for properties in italic
• generate documentation with force_optional configuration

Refactor

• locale-po: locale translation
• typo: french translation type

0.1.0 (2024-11-06)

0.1.0rc1 (2024-11-06)

Fix

• support variable dynamic with test as values
• update rougail dependency

0.1.0rc0 (2024-11-01)

Feat

• black + improvement