summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorthmsdt <thomas.kulik@telekom.de>2022-09-01 15:30:11 +0200
committerthmsdt <thomas.kulik@telekom.de>2022-09-01 16:24:11 +0200
commit624b78423917c5123efb885e5b4281bced436ec0 (patch)
tree8a412c7e1c4b32ecc2f638574f91390cd8c9ba1a /docs
parentb0ba1feaffb1fc366aaf0f5a46eb22124248caa5 (diff)
fix sphinx-build path in doc setup guide
Issue-ID: DOC-798 Signed-off-by: thmsdt <thomas.kulik@telekom.de> Change-Id: I27ced61b4d0b0abeaa4284d50cc7fffe85abee6e
Diffstat (limited to 'docs')
-rw-r--r--docs/guides/onap-documentation/setup-of-a-doc-dev-system.rst21
-rw-r--r--docs/release/component-release-notes.rst5
2 files changed, 15 insertions, 11 deletions
diff --git a/docs/guides/onap-documentation/setup-of-a-doc-dev-system.rst b/docs/guides/onap-documentation/setup-of-a-doc-dev-system.rst
index 424341b1f..6b43ec82b 100644
--- a/docs/guides/onap-documentation/setup-of-a-doc-dev-system.rst
+++ b/docs/guides/onap-documentation/setup-of-a-doc-dev-system.rst
@@ -42,10 +42,10 @@ Release Relevance
11.x.x (Kohn) - 10.x.x (Jakarta)
Last Review/Update
- 23/08/2022
+ 2022/09/01
Initial Release
- 05/12/2021
+ 2021/12/05
Author (Company)
Thomas Kulik (Deutsche Telekom AG)
@@ -243,12 +243,19 @@ Install the required packages with ...
jq \
tox
-Check the git version with ...
+Check the git version and the path of the sphinx-build executable ...
.. code-block:: bash
git --version
+ which sphinx-build
+
+
+.. tip:: Remember the path
+ ``/usr/bin/sphinx-build``, you need it later
+ to configure a VSC extension.
+
-------------------------------------------------------------------------------
Create virtual environment and activate
@@ -294,12 +301,6 @@ your terminal has changed. Now it starts with ``(onapdocs)``.
pip3 install wheel
- which sphinx-build
-
-.. tip:: Remember the path
- ``/home/<USER>/environments/onapdocs/bin/sphinx-build``, you need it later
- to configure a VSC extension.
-
-------------------------------------------------------------------------------
Install Visual Studio Code (VSC) and update already installed applications
@@ -477,7 +478,7 @@ all the parameters. Change the following ones:
``doc8``
:strong:`Restructuredtext: Sphinx Build Path`
- ``/home/<USER>/environments/onapdocs/bin/sphinx-build``
+ ``/usr/bin/sphinx-build``
Replace ``<USER>`` with your user name.
diff --git a/docs/release/component-release-notes.rst b/docs/release/component-release-notes.rst
index 34b0b6942..2d3d61810 100644
--- a/docs/release/component-release-notes.rst
+++ b/docs/release/component-release-notes.rst
@@ -101,7 +101,10 @@ SO - Service Orchestration
UUI - Use Case User Interface
-----------------------------
-- :ref:`usecase-ui <onap-usecase-ui:release_notes>`
+
+<currently unavailable>
+
+.. - :ref:`usecase-ui <onap-usecase-ui:release_notes>`
VFC - Virtual Function Controller
---------------------------------