From 09767157909e3e105a39b9015c8b21f2f46fd58d Mon Sep 17 00:00:00 2001 From: JakobKrieg Date: Thu, 6 Aug 2020 09:23:22 +0200 Subject: [PATCH] Add warning for copying/replacing conf.py in Guide for Testing One Project Issue-ID: DOC-651 Change-Id: I4f7a55b6e622598b746332aa5d8d7b88607ccefc Signed-off-by: JakobKrieg --- .../guides/onap-developer/how-to-use-docs/include-documentation.rst | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/docs/guides/onap-developer/how-to-use-docs/include-documentation.rst b/docs/guides/onap-developer/how-to-use-docs/include-documentation.rst index c59e956a1..91f530983 100644 --- a/docs/guides/onap-developer/how-to-use-docs/include-documentation.rst +++ b/docs/guides/onap-developer/how-to-use-docs/include-documentation.rst @@ -475,6 +475,12 @@ Change directory to doc & install requirements. cd doc pip install -r etc/requirements.txt +.. warning:: + + Just follow the next step (copying conf.py from Doc project to your project) + if that is your intention, otherwise skip it. Currently all projects should already have a conf.py file. + Through the next step, this file and potential extensions in your project get overriden. + Copy the conf.py file to your project folder where RST files have been kept: .. code-block:: bash -- 2.16.6