Add warning for copying/replacing conf.py in Guide for Testing One Project 51/110951/1
authorJakobKrieg <jakob.krieg@bcmsolutions.de>
Thu, 6 Aug 2020 07:23:22 +0000 (09:23 +0200)
committerJakobKrieg <jakob.krieg@bcmsolutions.de>
Thu, 6 Aug 2020 07:24:13 +0000 (09:24 +0200)
Issue-ID: DOC-651
Change-Id: I4f7a55b6e622598b746332aa5d8d7b88607ccefc
Signed-off-by: JakobKrieg <jakob.krieg@bcmsolutions.de>
docs/guides/onap-developer/how-to-use-docs/include-documentation.rst

index c59e956..91f5309 100644 (file)
@@ -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