Building Documentation
To build FRR documentation, first install the dependencies.
Notice that if you plan to only build html documenation, you only
need the package python3-sphinx
.
sudo apt-get install -y python3-sphinx \
texlive-latex-base texlive-latex-extra latexmk
To prepate for building both user and developer documentation, do:
cd doc
make
User documentation
To build html user documentation:
cd user
make html
This will generate html documentation files under _build/html/
.
With the main page named index.html
.
PFD can then be built by:
cd user
make pdf
The generated PDF file will be saved at _build/latex/FRR.pdf
Developer documentation
To build the developer documentation:
cd developer
make html
This will generate html documentation files under _build/html/
.
With the main page named index.html
.
PFD can then be built by:
cd developer
make pdf
The generated PDF file will be saved at _build/latex/FRR.pdf