proxmox-mirrors/mirror_frr
1
0
Fork 0
mirror of https://git.proxmox.com/git/mirror_frr synced 2025-08-13 16:26:10 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

doc: building html/pdf user and developer documentation

Browse Source 
Signed-off-by: Jafar Al-Gharaibeh <jafar@atcorp.com>
This commit is contained in:
Jafar Al-Gharaibeh 2025-01-13 01:38:32 -06:00
parent fd4a76cb2f
commit a78161de7f
2 changed files with 63 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

62
doc/developer/building-doc.rst Normal file
View File

@ -0,0 +1,62 @@
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``.
.. code-block:: console
sudo apt-get install -y python3-sphinx \
texlive-latex-base texlive-latex-extra latexmk
To prepate for building both user and developer documentation, do:
.. code-block:: console
cd doc
make
User documentation
------------------
To build html user documentation:
.. code-block:: console
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:
.. code-block:: console
cd user
make pdf
The generated PDF file will be saved at ``_build/latex/FRR.pdf``
Developer documentation
-----------------------
To build the developer documentation:
.. code-block:: console
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:
.. code-block:: console
cd developer
make pdf
The generated PDF file will be saved at ``_build/latex/FRR.pdf``

1
doc/developer/subdir.am
View File

@ -28,6 +28,7 @@ dev_RSTFILES = \
doc/developer/building-frr-for-ubuntu1804.rst \
doc/developer/building-frr-for-ubuntu2004.rst \
doc/developer/building-frr-for-ubuntu2204.rst \
doc/developer/building-doc.rst \
doc/developer/building-libunwind-note.rst \
doc/developer/building-libyang.rst \
doc/developer/building.rst \