diff options
Diffstat (limited to 'INSTALL.rst')
| -rw-r--r-- | INSTALL.rst | 7 |
1 files changed, 2 insertions, 5 deletions
diff --git a/INSTALL.rst b/INSTALL.rst index 95dd063a2..99626a554 100644 --- a/INSTALL.rst +++ b/INSTALL.rst @@ -237,15 +237,12 @@ Building the API documentation of cvc5 requires the following dependencies: `sphinxcontrib-bibtex <https://sphinxcontrib-bibtex.readthedocs.io>`_ - `Breathe <https://breathe.readthedocs.io>`_ -To build the documentation, configure cvc5 with ``./configure.sh --docs``. -Building cvc5 will then include building the API documentation. +To build the documentation, configure cvc5 with ``./configure.sh --docs`` and +run ``make docs`` from within the build directory. The API documentation can then be found at ``<build_dir>/docs/sphinx/index.html``. -To only build the documentation, change to the build directory and call -``make docs``. - To build the documentation for GitHub pages, change to the build directory and call ``make docs-gh``. The content of directory ``<build_dir>/docs/sphinx-gh`` can then be copied over to GitHub pages. |