[40/42] docs/qapidoc: cull (most) un-named entities from docs

Commit Message

John Snow Feb. 5, 2025, 11:12 p.m. UTC

This patch excludes any items not marked visible from the transmogrifier
output. The legacy qapidoc mechanism continues to ignore this flag, so
the existing docs are not effected.

Signed-off-by: John Snow <[e-mail]>
---
 docs/sphinx/qapidoc.py | 7 +++++++
 1 file changed, 7 insertions(+)

Patch

diff --git a/docs/sphinx/qapidoc.py b/docs/sphinx/qapidoc.py
index 86c13520d94..e7da5b2225f 100644
--- a/docs/sphinx/qapidoc.py
+++ b/docs/sphinx/qapidoc.py
@@ -616,6 +616,13 @@  def visit_freeform(self, doc) -> None:
     def visit_entity(self, ent):
         assert ent is not None
 
+        # Some entities need not be rendered; they are not exposed via
+        # introspection and are only relevant for purposes of
+        # inlining/inheritance. They don't need their own entries and
+        # don't need to be in the index.
+        if not ent.doc_visible:
+            return
+
         try:
             self._curr_ent = ent
             # This line gets credited to the start of the /definition/.