From 1376fbbd750b2dcfa63a9c89b19469f15247d5d3 Mon Sep 17 00:00:00 2001 From: Sarah Chastain Date: Tue, 16 Jul 2024 12:01:43 -0600 Subject: [PATCH] Update README.md Clarifications to docs instructions --- README.md | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 16d688790..558d14eaa 100644 --- a/README.md +++ b/README.md @@ -175,8 +175,17 @@ your machine. ### Building the Docs from Scratch -Install sphinx and breathe using pip, and also install Doxygen. +Install breathe using pip: + $ python -m pip install breathe sphinx + +Also install Doxygen using your package manager. +In Ubuntu, for example: + + $ sudo apt install Doxygen + +Otherwise check https://www.doxygen.nl/ for Doxygen install instructions. + Doxygen documentation can be generated by running: $ make doc