From 43d46efef0aa5df8f9fad4df01e525432921fa29 Mon Sep 17 00:00:00 2001 From: Emmanuel Garette Date: Sun, 21 Jun 2026 18:23:40 +0200 Subject: [PATCH] =?UTF-8?q?bump:=20version=201.0.0rc1=20=E2=86=92=201.0.0?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- CHANGELOG.md | 457 +++++--------------------- pyproject.toml | 2 +- src/rougail/output_doc/__version__.py | 2 +- 3 files changed, 84 insertions(+), 377 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index c5ef1987f..30bcd478a 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,415 +1,46 @@ -## 1.0.0rc1 (2026-06-21) +## 1.0.0 (2026-06-21) ### Feat - better ansible documentation - -## 0.2.0a51 (2026-06-15) - -### Fix - -- update tests - -## 0.2.0a50 (2026-06-11) - -### Feat - - leadership => sequence - -### Fix - -- test example with mode - -## 0.2.0a49 (2026-05-06) - -### Fix - -- example for partial documentation - -## 0.2.0a48 (2026-05-04) - -### Fix - -- get unrestraint default value - -## 0.2.0a47 (2026-04-30) - -### Feat - - add dot if needed - better documentation generation - -### Fix - -- 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 - -## 0.2.0a46 (2026-01-29) - -### Feat - - support transitive - -### Fix - -- better transitive documentation -- update translation - -## 0.2.0a45 (2026-01-21) - -### Feat - - doc transitive properties - -### Fix - -- root could be a variable -- path - -## 0.2.0a44 (2026-01-14) - -### Fix - -- yaml in output format do not convert object to str - -## 0.2.0a43 (2026-01-14) - -### Feat - - add 'document_a_type' option - -## 0.2.0a42 (2026-01-04) - -### Feat - - remove doc.root, pass directly the family to doc output (be careful, add true_config parameter too) - -## 0.2.0a41 (2025-12-30) - -### Fix - -- update tests -- read_write is a boolean - -## 0.2.0a40 (2025-12-22) - -### Feat - - personalise column number - document commandline and environment variable - -### Fix - -- better documentation -- better commandline doc + params description is now in rougail - -## 0.2.0a39 (2025-11-21) - -### Feat - - change path in description - add anchor to markdown format and remove unsupported character in anchor id - use blockquote for family description - -### Fix - -- dynamic variables with identifier in description -- gitlab id in anchor with dynamic variables - -## 0.2.0a38 (2025-11-10) - -### Feat - - better enter support - -## 0.2.0a37 (2025-11-06) - -### Feat - - delete/underline is inside tag for some format - can reload formatter - can document part by part with reloading structure - -## 0.2.0a36 (2025-10-29) - -### Feat - - anchor in gitlab output_format - can had comments with family/variable description in examples doc - comment variables from a family - -## 0.2.0a35 (2025-10-27) - -### Feat - - tags documentation - -### Fix - -- add changelog support for github/gitlab format -- tests - -## 0.2.0a34 (2025-10-22) - -### Feat - - ca force true_color terminal when export to console - -### Fix - -- parse subtree for a dynamic -- adapt api for rougail-web-ui -- undocumented variable in dynamic - -## 0.2.0a33 (2025-10-16) - -### Feat - - can document a variable for a specified identifier - can remove header when generate a table - add html output - changelog for variables - -### Fix - -- 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 - -## 0.2.0a32 (2025-10-03) - -### Fix - -- property calculated with disabled variable -- better disabled support - -## 0.2.0a31 (2025-10-02) - -### Feat - - limit warning when asked - -## 0.2.0a30 (2025-10-02) - -### Feat - - better support variable calculation for property - -## 0.2.0a29 (2025-10-02) - -### Fix - -- property for namespace - -## 0.2.0a28 (2025-10-02) - -### Feat - - add gitlab plugin - -### Fix - -- tests for formatter -- update translation - -## 0.2.0a27 (2025-09-29) - -### Fix - -- doc network with CIDR format -- better doc for calculation with unknown variable - -## 0.2.0a26 (2025-09-29) - -### Feat - - default value for a calculated variable with an unknown optional variable - add integer type which will replace number type - -## 0.2.0a25 (2025-09-22) - -### Feat - - adapt to tiramisu-web-ui - -## 0.2.0a24 (2025-06-19) - -### Feat - - could not change default value during annotator - -## 0.2.0a23 (2025-06-18) - -### Fix - -- separation - -## 0.2.0a22 (2025-06-18) - -### Fix - -- rougail separation - -## 0.2.0a21 (2025-05-12) - -### Fix - -- update translation -- black -- doc example with leader example lower than leader default value - -## 0.2.0a20 (2025-05-09) - -### Fix - -- undefined is a rougail object - -## 0.2.0a19 (2025-05-05) - -### Fix - -- update translation - -## 0.2.0a18 (2025-05-05) - -### Fix - -- doc default value with undocumented variable - -## 0.2.0a17 (2025-05-05) - -### Fix - -- description for all calculations -- better documentation variable with variable in default attribut - -## 0.2.0a16 (2025-04-30) - -### Fix - -- update translation -- remove negative_description support -- better documentation with hidden variable in property calculation -- use new information ymlfiles -- update tests -- better dynamic support - -## 0.2.0a15 (2025-04-09) - -### Fix - -- version - -## 0.2.0a14 (2025-04-07) - -### Fix - -- calculation for dynamic ans leadership variables - -## 0.2.0a13 (2025-04-02) - -### Fix - -- error in disabled dynamic variable - -## 0.2.0a12 (2025-04-01) - -### Fix - -- update tests -- groups.namespace could be unexistant - -## 0.2.0a11 (2025-03-31) - -### Fix - -- doc a param with a set but with only one item - -## 0.2.0a10 (2025-03-30) - -### Feat - - document unix file name parameters - better console output - do not document reference to undocumented variable - -### Fix - -- doc for param -- support NamespaceCalculation -- convert to <ENV> for github plugin - -## 0.2.0a9 (2025-02-19) - -### Fix - -- support suffix (in version 1.0 format) in calculation - -## 0.2.0a8 (2025-02-19) - -### Fix - -- key is the path - -## 0.2.0a7 (2025-02-19) - -### Fix - -- with_family => without_family and with_example => example - -## 0.2.0a6 (2025-02-17) - -### Feat - - add with_family parameter - -## 0.2.0a5 (2025-02-17) - -### Fix - -- do not add multiple attribute several time in json export - -## 0.2.0a4 (2025-02-10) - -### Feat - - output return status too - -## 0.2.0a3 (2025-01-04) - -### Fix - -- detect_symlink => only_self - -## 0.2.0a2 (2025-01-04) - -### Feat - - create tests - -### Fix - -- do not document symlink -- remove prefix_path - -## 0.2.0a1 (2024-11-28) - -### Fix - -- separation between run and print function - -## 0.2.0a0 (2024-11-20) - -### Feat - - personalize mode that we want disable documentation - add console output - better dynamique family support @@ -417,14 +48,90 @@ ### 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 - -## 0.1.1a0 (2024-11-08) - -### Fix - - 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) diff --git a/pyproject.toml b/pyproject.toml index ff0d95796..aafc7ce76 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -4,7 +4,7 @@ requires = ["flit_core >=3.8.0,<4"] [project] name = "rougail.output_doc" -version = "1.0.0rc1" +version = "1.0.0" authors = [{name = "Emmanuel Garette", email = "gnunux@gnunux.info"}] readme = "README.md" description = "Rougail output doc" diff --git a/src/rougail/output_doc/__version__.py b/src/rougail/output_doc/__version__.py index 6c93125ca..5becc17c0 100644 --- a/src/rougail/output_doc/__version__.py +++ b/src/rougail/output_doc/__version__.py @@ -1 +1 @@ -__version__ = "1.0.0rc1" +__version__ = "1.0.0"