Sphinx Build
============

.. flowtool:: Sphinx Build
   :id: FLTL_SPHINX
   :status: approved
   :tags: ubflow, installer

   The ``sphinx-build`` command renders the RST documentation into HTML and
   validates all Sphinx-Needs references. Used as the final validation step
   after installation to confirm the project builds cleanly.

Usage
-----

.. code-block:: bash

   sphinx-build -b html -W --keep-going <docs_root> <docs_root>/_build/html

- ``-b html`` — HTML builder.
- ``-W`` — treat warnings as errors.
- ``--keep-going`` — report all errors before aborting, not just the first.

Constraints
-----------

- MUST be invoked only after all undefined-reference checks pass.
- A non-zero exit code means the installation is incomplete; the agent
  MUST report the Sphinx output verbatim so the user can fix the errors.