Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
Clarifications to docs instructions
  • Loading branch information
dentalfloss1 authored Jul 16, 2024
1 parent df22011 commit 1376fbb
Showing 1 changed file with 10 additions and 1 deletion.
11 changes: 10 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 1376fbb

Please sign in to comment.