Skip to contentSkip to conversation

docs: cleanup and fix

PATCH In review Andrea Cervesato 3 participants 6 messages Jun 17, 2025

lore
Share & tools
lore
#0 lore raw

cover docs: cleanup and fix

We currently faced a modification of open12 test, that was causing a failure in the documentation build, due to the wrong definition of .type as .type = NULL. The test was fixed, but everytime we have an empty filesystem type, such as it is now in the open12 test, we end up having a documentation build failure. This series of patches are checking if one of the metadata attributes is having empty values and it eventually skips that parameter in the attributes test list.

---
Andrea Cervesato (2):
docs: make sure docs are built if filesystems is empty
docs: make sphinx verbose so it's easier to debug in CI

 doc/Makefile | 2 +-
 doc/conf.py  | 3 ++-
 2 files changed, 3 insertions(+), 2 deletions(-)

---
base-commit: 080ced081cfff577991c9b71ddb850bdbb9355a0
change-id: 20250617-doc_fix_table_generate-8deee06f937a

Best regards,

Signature · 5 lines
Andrea Cervesato <[email protected]>


-- 
Mailing list info: https://lists.linux.it/listinfo/ltp
#1 lore raw

PATCH 1/2 docs: make sure docs are built if filesystems is empty

From: Andrea Cervesato <[email protected]>

---
 doc/conf.py | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)
doc/conf.py +2 -1
index 23fe7a1b9742f604a5b97f0db62b29ed9c64c445..da768232b5451bd507d2ffacc12e20c2e0a8321c 100644
@@ -422,7 +422,8 @@ def _generate_setup_table(keys):
             else:
                 values.append(value)
 
-        table.extend(_generate_table_cell(key, values))
+        if values:
+            table.extend(_generate_table_cell(key, values))
 
     return table
 
Signature · 5 lines
2.43.0


-- 
Mailing list info: https://lists.linux.it/listinfo/ltp
Reviewed-by on v1 1/2
#2 lore raw

Re: [LTP] [PATCH 1/2] docs: make sure docs are built if filesystems is empty

Hi!
So the problem is that if we do not find anything interesting in the metadata we attempt to append empty values. The fix looks good.

Signature · 5 lines
Cyril Hrubis
[email protected]

-- 
Mailing list info: https://lists.linux.it/listinfo/ltp
#3 lore raw

PATCH 2/2 docs: make sphinx verbose so it's easier to debug in CI

In reply to Andrea Cervesato

From: Andrea Cervesato <[email protected]>

---
 doc/Makefile | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
doc/Makefile +1 -1
index 2062d6e935618d96c169b4a6183441715e768ef6..3123b1cd7a1568d2c7783c28a3d42cb313253e3c 100644
@@ -24,7 +24,7 @@ ${abs_top_builddir}/metadata/ltp.json:
 	$(MAKE) -C ${abs_top_builddir}/metadata
 
 all: ${abs_top_builddir}/metadata/ltp.json
-	$(RUN_VENV); sphinx-build -b html . html
+	$(RUN_VENV); sphinx-build -v -b html . html
 
 spelling:
 	$(RUN_VENV); sphinx-build -b spelling -d build/doctree . build/spelling
Signature · 5 lines
2.43.0


-- 
Mailing list info: https://lists.linux.it/listinfo/ltp
#5 lore raw
In reply to Andrea Cervesato

Merged!

- Andrea

Quoted 22 lines · Andrea Cervesato

We currently faced a modification of open12 test, that was causing a failure in the documentation build, due to the wrong definition of .type as .type = NULL. The test was fixed, but everytime we have an empty filesystem type, such as it is now in the open12 test, we end up having a documentation build failure. This series of patches are checking if one of the metadata attributes is having empty values and it eventually skips that parameter in the attributes test list.

---
Andrea Cervesato (2):
docs: make sure docs are built if filesystems is empty
docs: make sphinx verbose so it's easier to debug in CI

  doc/Makefile | 2 +-
  doc/conf.py  | 3 ++-
  2 files changed, 3 insertions(+), 2 deletions(-)

---
base-commit: 080ced081cfff577991c9b71ddb850bdbb9355a0
change-id: 20250617-doc_fix_table_generate-8deee06f937a

Best regards,

Signature · 1 line
Mailing list info: https://lists.linux.it/listinfo/ltp