[LTP] [PATCH v2 1/1] doc/conf.py: Replace all titles

[LTP] [PATCH v2 1/1] doc/conf.py: Replace all titles

[Petr Vorel]

This fixes titles like "[Race Description]".

Fixes: 1bf344a3db ("doc: add tests catalog page")
Signed-off-by: Petr Vorel <pvorel@suse.cz>
---
Link to v1:
https://patchwork.ozlabs.org/project/ltp/patch/20250218121553.2470592-1-pvorel@suse.cz/

Changes from v1:
* Use re.compile (Andrea)

 doc/conf.py | 9 +++------
 1 file changed, 3 insertions(+), 6 deletions(-)

diff --git a/doc/conf.py b/doc/conf.py
index 03fcff67e8..2be847d90b 100644
--- a/doc/conf.py
+++ b/doc/conf.py
@@ -434,6 +434,7 @@ def generate_test_catalog(_):
         metadata = json.load(data)
 
     timeout_def = metadata['defaults']['timeout']
+    regexp = re.compile(r'^\[([A-Za-z][\w\W]+)\]')
 
     for test_name, conf in sorted(metadata['tests'].items()):
         text.extend([
@@ -455,12 +456,8 @@ def generate_test_catalog(_):
         if desc:
             desc_text = []
             for line in desc:
-                if line.startswith("[Description]"):
-                    desc_text.append("**Description**")
-                elif line.startswith("[Algorithm]"):
-                    desc_text.append("**Algorithm**")
-                else:
-                    desc_text.append(line)
+                line = regexp.sub(r'**\1**', line)
+                desc_text.append(line)
 
             text.extend([
                 '\n'.join(desc_text),
-- 
2.47.2


-- 
Mailing list info: https://lists.linux.it/listinfo/ltp

Re: [LTP] [PATCH v2 1/1] doc/conf.py: Replace all titles

[Andrea Cervesato via ltp]

Hi Petr,

Acked-by: Andrea Cervesato <andrea.cervesato@suse.com>

Feel free to merge.

Andrea

On 2/18/25 14:34, Petr Vorel wrote:
> This fixes titles like "[Race Description]".
>
> Fixes: 1bf344a3db ("doc: add tests catalog page")
> Signed-off-by: Petr Vorel <pvorel@suse.cz>
> ---
> Link to v1:
> https://patchwork.ozlabs.org/project/ltp/patch/20250218121553.2470592-1-pvorel@suse.cz/
>
> Changes from v1:
> * Use re.compile (Andrea)
>
>   doc/conf.py | 9 +++------
>   1 file changed, 3 insertions(+), 6 deletions(-)
>
> diff --git a/doc/conf.py b/doc/conf.py
> index 03fcff67e8..2be847d90b 100644
> --- a/doc/conf.py
> +++ b/doc/conf.py
> @@ -434,6 +434,7 @@ def generate_test_catalog(_):
>           metadata = json.load(data)
>   
>       timeout_def = metadata['defaults']['timeout']
> +    regexp = re.compile(r'^\[([A-Za-z][\w\W]+)\]')
>   
>       for test_name, conf in sorted(metadata['tests'].items()):
>           text.extend([
> @@ -455,12 +456,8 @@ def generate_test_catalog(_):
>           if desc:
>               desc_text = []
>               for line in desc:
> -                if line.startswith("[Description]"):
> -                    desc_text.append("**Description**")
> -                elif line.startswith("[Algorithm]"):
> -                    desc_text.append("**Algorithm**")
> -                else:
> -                    desc_text.append(line)
> +                line = regexp.sub(r'**\1**', line)
> +                desc_text.append(line)
>   
>               text.extend([
>                   '\n'.join(desc_text),

-- 
Mailing list info: https://lists.linux.it/listinfo/ltp

Re: [LTP] [PATCH v2 1/1] doc/conf.py: Replace all titles

[Petr Vorel]

Hi Andrea,

Thanks, merged!

Kind regards,
Petr

-- 
Mailing list info: https://lists.linux.it/listinfo/ltp