diff options
| author | Jafar Al-Gharaibeh <jafar@atcorp.com> | 2025-01-13 08:38:32 +0100 |
|---|---|---|
| committer | Jafar Al-Gharaibeh <jafar@atcorp.com> | 2025-01-13 17:24:12 +0100 |
| commit | a78161de7f26f7af0412f343fac4dd05a1688438 (patch) | |
| tree | 96584ccd97e0bbe58dcf459eb8d2a6f99344c478 /doc | |
| parent | doc: fix LaTex warning when building pdf docs (diff) | |
| download | frr-a78161de7f26f7af0412f343fac4dd05a1688438.tar.xz frr-a78161de7f26f7af0412f343fac4dd05a1688438.zip | |
doc: building html/pdf user and developer documentation
Signed-off-by: Jafar Al-Gharaibeh <jafar@atcorp.com>
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/developer/building-doc.rst | 62 | ||||
| -rw-r--r-- | doc/developer/subdir.am | 1 |
2 files changed, 63 insertions, 0 deletions
diff --git a/doc/developer/building-doc.rst b/doc/developer/building-doc.rst new file mode 100644 index 000000000..bf0544ccc --- /dev/null +++ b/doc/developer/building-doc.rst @@ -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`` diff --git a/doc/developer/subdir.am b/doc/developer/subdir.am index 652ee4e1a..bdf93a05c 100644 --- a/doc/developer/subdir.am +++ b/doc/developer/subdir.am @@ -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 \ |