From 183da6b29b48fbec6671f04358d3dde1c1c7bc58 Mon Sep 17 00:00:00 2001 From: Roland Conybeare Date: Tue, 2 Apr 2024 17:29:52 -0400 Subject: [PATCH] xo-unit: README: instructions for building sphinx docs --- README.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/README.md b/README.md index 68174012..5af84f03 100644 --- a/README.md +++ b/README.md @@ -23,6 +23,13 @@ $ make $ make install ``` +### build documentation +``` +$ cd xo-unit +$ cmake --build .build -- sphinx +``` +When this completes, point local browser to `xo-unit/.build/docs/sphinx/index.html`. + ### build for unit test coverage ``` $ cd xo-unit