summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorthmsdt <thomas.kulik@telekom.de>2022-10-25 08:03:37 +0200
committerthmsdt <thomas.kulik@telekom.de>2022-10-25 11:11:43 +0200
commit3d8a7ed82eb7925846e0c27d475c7342c1f51be4 (patch)
treede1d284893bf218dacad683df842cb6b6e9cd421
parentaeadb240bf26195cdde389440dcd56f9a3245489 (diff)
again fix doc guide issues
Issue-ID: DOC-798 Signed-off-by: thmsdt <thomas.kulik@telekom.de> Change-Id: Iec655a506402d54587a167b6857182492cb51d64
-rw-r--r--docs/guides/onap-documentation/setup-of-a-doc-dev-system.rst21
1 files changed, 8 insertions, 13 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 cf58cefc9..c08427bf5 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,7 +42,7 @@ Release Relevance
11.x.x (Kohn)
Last Review/Update
- 2022/10/24
+ 2022/10/25
Initial Release
2021/12/05
@@ -92,8 +92,8 @@ VM Configuration
.. note:: This section is for information only and should not be understood as
a requirement.
-Ubuntu Image
-------------
+Ubuntu Image Used
+-----------------
+--------------------------------------+
| ubuntu-22.04.1-desktop-amd64.iso |
@@ -258,8 +258,10 @@ Install the required packages with ...
sudo apt install -y git \
git-review \
+ python-wheel-common \
python3-sphinx \
python3-doc8 \
+ graphviz \
docutils \
curl \
tox \
@@ -392,15 +394,8 @@ Install required Sphinx packages
and conflicting behaviour with the system package manager*". We try to avoid
this installation method in a later version of this guide.
-Install required Sphinx packages with ...
-
-.. code-block:: bash
-
- sudo pip install wheel
-
-Continue with the installation of required packages. Use the file
-``requirements-docs.txt`` for it. The file resides in the downloaded ``doc``
-repository.
+Install required Sphinx packages using the file ``requirements-docs.txt`` as an
+input. The file resides in the downloaded ``doc`` repository.
.. code-block:: bash
@@ -542,7 +537,7 @@ the listed values:
* - esbonio.sphinx.buildDir
- ${workspaceFolder}/_build
* - restructuredtext.styles
- - "/usr/local/lib/python3.10/dist-packages/sphinx_rtd_theme/static/css/theme.css"
+ - /usr/local/lib/python3.10/dist-packages/sphinx_rtd_theme/static/css/theme.css
Close the :guilabel:`Extension Settings` window.