Update the documentation on how to build the documentation (#697)

Co-authored-by: Enrico Stragiotti <enrico.stragiotti@onera.fr>
SMTorg · Dec 17, 2024 · c65e721 · c65e721
1 parent 5722846
commit c65e721
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 2 deletions.
diff --git a/doc/_src_docs/dev_docs.rst b/doc/_src_docs/dev_docs.rst
diff --git a/doc/_src_docs/dev_docs.rstx b/doc/_src_docs/dev_docs.rstx
@@ -43,7 +43,8 @@ Users can read the docs online at `smt.readthedocs.io <https://smt.readthedocs.i
 This is especially necessary because most of the docs in SMT contain code, code print output, and plots that are dynamically generated and embedded during the doc building process.
 The docs are written using reStructuredText, and there are a few custom directives we have added for this embedding of dynamically-generated content.
 
-First, install the required dependencies to build the doc with: ``pip install -r doc/requirements.txt``
+First, install the required package dependencies with: ``pip install -e .``.
+Additionally, install the required dependencies to build the doc with: ``pip install -r doc/requirements.txt``.
 
 Then to generate the doc, the developer should go to the ``doc`` directory and run ``sphinx_auto_embed``, then ``make html``.