docs: Add Makefile generation target

Zildj1an · Zildj1an · commit f0696055e4f5 · 2023-10-16T11:17:32.000-05:00
Add Makefile target to generate cargo documentation and update README
accordingly.

Signed-off-by: Carlos Bilbao &lt;carlos.bilbao@amd.com&gt;
diff --git a/Makefile b/Makefile
@@ -19,6 +19,9 @@ all: svsm.bin
 test:
 	cargo test --target=x86_64-unknown-linux-gnu
 
+doc:
+	cargo doc --open --document-private-items
+
 utils/gen_meta: utils/gen_meta.c
 	cc -O3 -Wall -o $@ $<
 
diff --git a/README.md b/README.md
@@ -76,6 +76,17 @@ any way:
   replacement for the FW when launching QEMU
 * Live migration
 
+Documentation
+-------------
+
+Coconut-SVSM components are documented using rustdoc, a tool that produces
+a user-friendly, browsable website explaining the code's contents. To
+generate and open the documentation, simply execute the following command:
+
+```
+$ make doc
+```
+
 Acknowledgments
 ---------------
 
