diff options
| author | Donald Sharp <donaldsharp72@gmail.com> | 2025-01-14 09:37:09 -0500 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2025-01-14 09:37:09 -0500 |
| commit | ef4b28682b533d51149482961a8637e7e977b52f (patch) | |
| tree | 1011d6cadd962cf068a4f4cd686915ecfce403a2 /doc/developer | |
| parent | b4619da9388759cd718e61e8b89b814b60021a18 (diff) | |
| parent | a78161de7f26f7af0412f343fac4dd05a1688438 (diff) | |
Merge pull request #17846 from Jafaral/fix-latex-warn
doc: fix LaTex warnings, add documentation to build docs
Diffstat (limited to 'doc/developer')
| -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 0000000000..bf0544ccc8 --- /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 652ee4e1af..bdf93a05c1 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 \ |