git.sur5r.net Git - freertos/blob - FreeRTOS/Demo/RISC-V_RV32_SiFive_HiFive1_GCC/freedom-metal/doc/README.md

   1 # Documentation Generation
   2
   3 ## Requirements
   4
   5 You'll need the following software:
   6 - [Doxygen](http://www.doxygen.nl/index.html)
   7 - [Sphinx](http://www.sphinx-doc.org/en/master/index.html)
   8 - LaTeX (For building a PDF)
   9
  10 ### Ubuntu
  11
  12 You can install the required software on Ubuntu with the following:
  13
  14 ```
  15 sudo apt install doxygen python3-sphinx python3-breathe graphviz python3-pydot
  16 sudo apt install texlive-full latexmk
  17 ```
  18
  19 The second line can be omitted if you don't intend to build the PDF.
  20
  21 ### MacOS
  22
  23 You can install the required software on MacOS with the following:
  24
  25 ```
  26 brew install doxygen sphinx-doc graphviz
  27 brew cask install mactex
  28 ```
  29
  30 The second line can be omitted if you don't intend to build the PDF.
  31
  32 ## Building the Docs
  33
  34 You can generate both the HTML and PDF documentation with
  35 ```
  36 make
  37 ```
  38
  39 Or only the HTML or PDF docs using
  40
  41 ```
  42 make html
  43 ```
  44 or
  45
  46 ```
  47 make pdf
  48 ```
  49
  50 You can clean the build files and outputs with
  51
  52 ```
  53 make clean
  54 ```
  55