[elbe-devel] [PATCH] docs: mock out guestfs module in autodoc

Thomas Weißschuh thomas.weissschuh at linutronix.de
Fri Jun 14 15:35:33 CEST 2024


The guestfs module needs to be imported to use autodoc on elbevalidate.
As no types from that module are mentioned in the documentation it is
fine to mock this dependency.
This allows the build of the documentation without a full dependency
setup.

Signed-off-by: Thomas Weißschuh <thomas.weissschuh at linutronix.de>
---
 docs/conf.py | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/docs/conf.py b/docs/conf.py
index 3cefa58e8770..5a09202b1c40 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -178,3 +178,5 @@ texinfo_documents = [
 html_sidebars = {'**': ['globaltoc.html']}
 
 graphviz_output_format = 'svg'
+
+autodoc_mock_imports = ['guestfs']

---
base-commit: b1aac1fe6c64107cea0f5383b9b4f7e23670369b
change-id: 20240614-docs-guestfs-321bd7f2d024

Best regards,
-- 
Thomas Weißschuh <thomas.weissschuh at linutronix.de>



More information about the elbe-devel mailing list