docs/guides/onap-documentation/setup-of-a-doc-dev-system.rst

   1 .. This work is licensed under a Creative Commons Attribution 4.0 International
   2 .. License. http://creativecommons.org/licenses/by/4.0
   3 .. Copyright (C) 2021 Deutsche Telekom AG
   4
   5
   6
   7 *******************************************
   8 Setup of a Documentation Development System
   9 *******************************************
  10
  11
  12 ..
  13    #########################################################################
  14    HOW TO FILL THIS SECTION:
  15
  16    Release Relevance
  17       Name the ONAP release(s) where this document has a relevance.
  18       ONAP release number (ONAP release name starting with a capital letter)
  19       Examples:
  20       8.0.0 (Honolulu) - 1.0.0 (Amsterdam)
  21       7.0.1 (Guilin) - 3.0.0 (Casablanca), 1.0.0 (Amsterdam)
  22
  23    Last Review/Update
  24       Date of last review and/or update of this document.
  25       Add "none" for a new document. Add concrete date if reviewed/updated.
  26       Use en-US format (mm/dd/yyyy).
  27
  28    Initial Release
  29       Initial release date of this document.
  30       Use en-US format (mm/dd/yyyy).
  31
  32    Author (Company)
  33       Name of the author and company name. Use comma to separate.
  34       Example:
  35       Jane Doe (ACME), John Doe (ACME)
  36
  37    ! PLEASE DO NOT CHANGE THE STRUCTURE OF THIS SECTION.
  38    ! PLEASE ADD ONLY REQUESTED INFORMATION BELOW!
  39    #########################################################################
  40
  41 Release Relevance
  42    11.x.x (Kohn) - 10.x.x (Jakarta)
  43
  44 Last Review/Update
  45    23/08/2022
  46
  47 Initial Release
  48    05/12/2021
  49
  50 Author (Company)
  51    Thomas Kulik (Deutsche Telekom AG)
  52
  53 -------------------------------------------------------------------------------
  54
  55 .. contents:: Table of Contents
  56
  57 -------------------------------------------------------------------------------
  58
  59 Introduction
  60 ============
  61
  62 This guide provides a detailed description to set up a system suitable to
  63 create, check and preview documentation locally. The targeted readership are
  64 beginners and people interested in creating documentation.
  65
  66 The guide describes the setup of a development system from scratch using the
  67 Ubuntu Desktop version installed in a virtual machine. It includes all required
  68 steps and also some optional ones that may ease your daily work with this
  69 development system. Feel free to adapt it to your needs.
  70
  71 In general, formal ONAP documentation uses the reStructuredText markup language
  72 and the files have an ``.rst`` extension. They are part of almost every ONAP
  73 project and can be found in the ``docs`` directory. The files are automatically
  74 processed and you find the final ONAP documentation build hosted on
  75 `ReadTheDocs <https://docs.onap.org>`__.
  76
  77 Beginning with the 'Frankfurt' release of ONAP, the documentation structure has
  78 changed and the support of submodules was removed. Although large parts of this
  79 guide are valid for earlier releases, the relevance has been limited.
  80
  81 -------------------------------------------------------------------------------
  82
  83 VM Configuration
  84 ================
  85
  86 .. note:: This section is for information only and should not be understood as
  87           a requirement.
  88
  89 Ubuntu Image
  90 ------------
  91
  92 +--------------------------------------+
  93 | ubuntu-20.04.3-desktop-amd64.iso     |
  94 +--------------------------------------+
  95
  96 Please check what image must be used for your type of hardware.
  97
  98 VM Configuration
  99 ----------------
 100
 101 +-------------------------+------------+
 102 | Memory                  | 8 GB       |
 103 +-------------------------+------------+
 104 | Processors / Cores each | 2 / 2      |
 105 +-------------------------+------------+
 106 | Hard Disk               | 64 GB      |
 107 +-------------------------+------------+
 108
 109 Depending on your requirements you can modify the values for virtual memory,
 110 processors, cores or hard disk space.
 111
 112 VM Setup
 113 --------
 114
 115 Follow the instructions of your virtualization solution to install Ubuntu in a
 116 virtual machine. Log in after the installation has finished.
 117
 118 -------------------------------------------------------------------------------
 119
 120 Ubuntu Configuration
 121 ====================
 122
 123 .. note:: This section is optional and should not be understood as a
 124    requirement.
 125
 126 Finding Applications
 127 --------------------
 128
 129 The following actions are performed on the Ubuntu desktop. You may use the
 130 desktop search function :guilabel:`Show Applications` (the |ShowApp| symbol in
 131 the bottom left corner) to find the required applications. Later on you need to
 132 start also a :guilabel:`Terminal` window from here.
 133
 134 Software Updates
 135 ----------------
 136
 137 Open :guilabel:`Software Updater` and update already installed Ubuntu packages.
 138 You may need to restart the system afterwards.
 139
 140 Language Support
 141 ----------------
 142
 143 Open :guilabel:`Language Support`. You are asked to complete the installation.
 144 Select the :guilabel:`Install` button to complete. Continue in the
 145 :guilabel:`Language Support` window and open
 146 :guilabel:`Install / Remove Languages`. Then select your preferred
 147 :guilabel:`<LANGUAGE>`. Choose :guilabel:`Apply` to install the additional
 148 language.
 149
 150 Regional Formats
 151 ----------------
 152
 153 Continue to the :guilabel:`Regional Formats` tab. Select a
 154 :guilabel:`<FORMAT>` to show e.g. date, time and numbers in your preferred
 155 format. Press :guilabel:`Close` to close the window.
 156
 157 Input Sources
 158 -------------
 159
 160 To change the keyboard layout used e.g. in command line windows, open
 161 :guilabel:`Settings`. Navigate to :guilabel:`Region & Language`. At
 162 :guilabel:`Input Sources` press the :guilabel:`+` sign. Select your preferred
 163 :guilabel:`<INPUTSOURCE>` and use :guilabel:`Add` to add it. Move it to the top
 164 of the list using drag and drop. Close the window. You may need to logout from
 165 the UI and login again to make your changes effective.
 166
 167 Screen Lock
 168 -----------
 169
 170 Open :guilabel:`Settings`. Navigate to :guilabel:`Privacy` >
 171 :guilabel:`Screen Lock` and change settings for :guilabel:`Blank Screen Delay`
 172 and :guilabel:`Automatic Screen Lock` to values of your choice. Close the
 173 window.
 174
 175 -------------------------------------------------------------------------------
 176
 177 Disable sudo password for your user
 178 ===================================
 179
 180 .. warning:: This section is optional and should not be understood as a
 181    requirement. Disabling password authentication for all commands is very
 182    convenient at use **but it strongly exposes your system to malicious code**.
 183    For a system dedicated to development it might be OK, but not for a
 184    production system! Handle with care. You have been warned.
 185
 186 Open a :guilabel:`Terminal` window and start the ``visudo`` editor with ...
 187
 188 .. code-block:: bash
 189
 190    sudo visudo
 191
 192 and add ``<USER> ALL=(ALL) NOPASSWD:ALL`` to the end of the file. Replace
 193 ``<USER>`` with your user name.
 194
 195 -------------------------------------------------------------------------------
 196
 197 Install python3 related packages
 198 ================================
 199
 200 .. note:: The main python3 package is preinstalled in Ubuntu 20.04.
 201
 202 Open a :guilabel:`Terminal` window and update the package management system
 203 with ...
 204
 205 .. code-block:: bash
 206
 207    cd ~
 208    sudo apt update
 209    sudo apt -y upgrade
 210
 211 Install python3 related packages with ...
 212
 213 .. code-block:: bash
 214
 215    sudo apt install -y python3-pip \
 216                        build-essential \
 217                        libssl-dev \
 218                        libffi-dev \
 219                        python3-dev \
 220                        python3-venv
 221
 222
 223 Check the python3 version with ...
 224
 225 .. code-block:: bash
 226
 227    python3 -V
 228
 229 -------------------------------------------------------------------------------
 230
 231 Install git and documentation related packages
 232 ==============================================
 233
 234 Install the required packages with ...
 235
 236 .. code-block:: bash
 237
 238    sudo apt install -y git \
 239                        git-review \
 240                        python3-sphinx \
 241                        python3-doc8 \
 242                        curl \
 243                        jq \
 244                        tox
 245
 246 Check the git version with ...
 247
 248 .. code-block:: bash
 249
 250    git --version
 251
 252 -------------------------------------------------------------------------------
 253
 254 Create virtual environment and activate
 255 =======================================
 256
 257 In this guide, virtual environments are generally located in your home
 258 directory under ``~/environments``. For the development of ONAP documentation
 259 the virtual environment ``onapdocs`` is created. The full path is consequently
 260 ``~/environments/onapdocs``.
 261
 262 .. code-block:: bash
 263
 264    cd ~
 265    mkdir environments
 266    cd ~/environments
 267    python3 -m venv onapdocs
 268    cd ~/environments/onapdocs
 269    source bin/activate
 270
 271 To indicate that you are now working in an virtual environment, the prompt of
 272 your terminal has changed. Now it starts with ``(onapdocs)``.
 273
 274 -------------------------------------------------------------------------------
 275
 276 Install required Sphinx packages in activated environment (I)
 277 =============================================================
 278
 279 It is :strong:`important` to activate the ``onapdocs`` environment before you
 280 continue. If not already done, activate environment with ...
 281
 282 .. code-block:: bash
 283
 284    cd ~/environments/onapdocs
 285    source bin/activate
 286
 287 To indicate that you are now working in an virtual environment, the prompt of
 288 your terminal has changed. Now it starts with ``(onapdocs)``.
 289
 290 .. important:: Now you are installing packages only for the 'onapdocs' virtual
 291    environment.
 292
 293 .. code-block:: bash
 294
 295    pip3 install wheel
 296
 297    which sphinx-build
 298
 299 .. tip:: Remember the path
 300    ``/home/<USER>/environments/onapdocs/bin/sphinx-build``, you need it later
 301    to configure a VSC extension.
 302
 303 -------------------------------------------------------------------------------
 304
 305 Install Visual Studio Code (VSC) and update already installed applications
 306 ==========================================================================
 307
 308 The following actions are performed on the Ubuntu desktop. You may use the
 309 desktop search function :guilabel:`Show Applications` (the |ShowApp| symbol in
 310 the bottom left corner) to find the required applications.
 311
 312 Open :guilabel:`Ubuntu Software` > :guilabel:`Development`, select
 313 :guilabel:`code` (Visual Studio Code) and press :guilabel:`Install` to install
 314 the integrated development environment (IDE).
 315
 316 Open :guilabel:`Ubuntu Software` > :guilabel:`Updates` to ensure that your
 317 installed applications are up to date.
 318
 319 -------------------------------------------------------------------------------
 320
 321 Clone example repo (no LF account)
 322 ==================================
 323
 324 Clone repo
 325 ----------
 326
 327 For a quick start you can clone e.g. the ``doc`` repository even without a
 328 Linux Foundation (LF) account with ...
 329
 330 .. code-block:: bash
 331
 332    cd ~/environments/onapdocs
 333    git clone --branch master https://git.onap.org/doc/ ./doc
 334
 335 -------------------------------------------------------------------------------
 336
 337 Clone example repo (LF account used)
 338 ====================================
 339
 340 Prerequisite configuration
 341 --------------------------
 342
 343 If you plan to contribute to the ONAP community and you want to submit changes
 344 to a specific project later on, please refer to the
 345 `ONAP Developer Wiki <https://wiki.onap.org>`__ to get information about all
 346 the prerequisite details.
 347
 348 If you already have a LF account and you have shared your public ssh key you
 349 can finalize the configuration of this development system by updating your ssh
 350 configuration in the ``~/.ssh`` directory by copying over ``config``,
 351 ``id_rsa`` and ``id_rsa.pub``
 352
 353 In addition you configure ``git`` and ``git-review`` with ...
 354
 355 .. code-block:: bash
 356
 357    git config --global user.email "<GIT-EMAIL>"
 358    git config --global user.name "<GIT-USER>"
 359    git config --global --add gitreview.username "<GIT-USER>"
 360    git config --global gitreview.remote origin
 361
 362 Replace ``<GIT-EMAIL>`` and ``<GIT-USER>`` with your account details.
 363
 364 Clone repo
 365 ----------
 366
 367 .. code-block:: bash
 368
 369    cd ~/environments/onapdocs
 370    git clone ssh://<GIT-USER>@gerrit.onap.org:29418/doc
 371
 372 -------------------------------------------------------------------------------
 373
 374 Install required Sphinx packages in activated environment (II)
 375 ==============================================================
 376
 377 Continue with the installation of required packages. Use the file
 378 ``requirements-docs.txt`` for it. The file resides in the downloaded ``doc``
 379 repository.
 380
 381 .. code-block:: bash
 382
 383    cd ~/environments/onapdocs
 384    sudo pip install -r doc/etc/requirements-docs.txt
 385
 386 -------------------------------------------------------------------------------
 387
 388 Start VSC in the correct directory
 389 ==================================
 390
 391 Start VSC (always) in the ``docs`` directory of your repository. For the
 392 ``doc`` repository used in this example do this with ...
 393
 394 .. code-block:: bash
 395
 396    cd doc
 397    cd docs
 398    code .
 399
 400 .. important:: Don't forget the ``.`` (dot) when you start Visual Studio Code.
 401
 402 .. tip:: ``~/environments/onapdocs/doc/docs`` is now your
 403    ``${workspaceFolder}`` because you have started VSC (``code .``) from here!
 404
 405 -------------------------------------------------------------------------------
 406
 407 Disable Telemetry of VSC
 408 ========================
 409
 410 In case you want to disable telemetry functionality of Visual Studio Code, open
 411 :guilabel:`File` > :guilabel:`Preferences` > :guilabel:`Telemetry Settings` and
 412 turn it ``off`` in the selection field.
 413
 414 In an older version of VSC you alternatively need to open
 415 :guilabel:`File` > :guilabel:`Preferences` > :guilabel:`Settings` and
 416 search for ``telemetry``. Then uncheck
 417 :guilabel:`Telemetry: Enable Crash Reporter` and
 418 :guilabel:`Telemetry: Enable Telemetry`
 419
 420 .. warning:: Extensions may be collecting their own usage data and are not
 421    controlled by the ``telemetry.enableTelemetry`` setting. Consult the
 422    specific extension's documentation to learn about its telemetry
 423    reporting and whether it can be disabled. See also
 424    https://code.visualstudio.com/docs/getstarted/telemetry
 425
 426 -------------------------------------------------------------------------------
 427
 428 Install VSC extensions and configure reStructuredText extension
 429 ===============================================================
 430
 431 Install VSC extensions
 432 ----------------------
 433
 434 Extension bring additional power to Visual Studio Code. To search and install
 435 them, open :guilabel:`File` > :guilabel:`Preferences` > :guilabel:`Extensions`
 436 or use the keyboard shortcut ``[Ctrl+Shift+X]``. Then enter the name of the
 437 extension in the :guilabel:`Search Extensions in Marketplace` window.
 438 Press :guilabel:`Install` if you have found the required extension.
 439
 440 Please install ...
 441
 442 +--------------------------------------+---------------------------------------+---------+
 443 | Python                               | ms-python.python                      | latest  |
 444 +--------------------------------------+---------------------------------------+---------+
 445 | reStructuredText                     | lextudio.restructuredtext             | 169.0.0 |
 446 +--------------------------------------+---------------------------------------+---------+
 447 | reStructuredText Syntax highlighting | trond-snekvik.simple-rst              | latest  |
 448 +--------------------------------------+---------------------------------------+---------+
 449 | Code Spell Checker                   | streetsidesoftware.code-spell-checker | latest  |
 450 +--------------------------------------+---------------------------------------+---------+
 451 | Prettier                             | esbenp.prettier-vscode                | latest  |
 452 +--------------------------------------+---------------------------------------+---------+
 453 | GitLens                              | eamodio.gitlens                       | latest  |
 454 +--------------------------------------+---------------------------------------+---------+
 455
 456 .. warning:: Use the reStructuredText extension version 169.0.0 or lower to
 457    avoid problems with the preview. You need to downgrade after the initial
 458    installation. This can be done by using
 459    :guilabel:`Uninstall` > :guilabel:`Install Another Version...` in the VSC
 460    extension management.
 461
 462 Configure reStructuredText extension
 463 ------------------------------------
 464
 465 To configure ``reStructuredText`` extension, open :guilabel:`File` >
 466 :guilabel:`Preferences` > :guilabel:`Extensions` or use the keyboard shortcut
 467 ``[Ctrl+Shift+X]``. Then enter ``reStructuredText`` in the
 468 :guilabel:`Search Extensions in Marketplace` window. After you have found the
 469 extension press :guilabel:`Manage` (the little |GearSymb| symbol on the right
 470 bottom) and select :guilabel:`Extension Settings`. A new windows in VSC shows
 471 all the parameters. Change the following ones:
 472
 473  :strong:`Restructuredtext › Linter: Executable Path`
 474   ``/usr/bin/doc8``
 475
 476  :strong:`Restructuredtext › Linter: Name`
 477   ``doc8``
 478
 479  :strong:`Restructuredtext: Sphinx Build Path`
 480   ``/home/<USER>/environments/onapdocs/bin/sphinx-build``
 481
 482 Replace ``<USER>`` with your user name.
 483
 484 Only in case the preview creates an error message, try ...
 485
 486   :strong:`Restructuredtext: Conf Path`
 487    ``${workspaceFolder}/docs``
 488
 489 Close the :guilabel:`Extension Settings` window.
 490
 491 Close VSC and start it again with the ``code .`` command.
 492
 493 -------------------------------------------------------------------------------
 494
 495 Open a .rst file and preview it in VSC
 496 ======================================
 497
 498 Open .rst file
 499 --------------
 500
 501 Select :guilabel:`View` > :guilabel:`Explorer`. Or use the |FileExpl| symbol in
 502 the upper left corner. Expand the ``docs`` folder by clicking on the ``>``
 503 symbol. Select the file ``index.rst``. The code shows up in the right pane
 504 window of VSC.
 505
 506 Alternatively you can open this guide and see how it looks like in the
 507 reStructuredText format. It can be found in ``docs/guides/onap-documentation``
 508 and is named ``setup-of-a-doc-dev-system.rst``.
 509
 510 Problem Window
 511 --------------
 512
 513 You may see problems with the reStructuredText markup because the code is
 514 underlined in various colors. For the details select :guilabel:`View` >
 515 :guilabel:`Problems` to open an additional window at the bottom of VSC.
 516
 517 When you select a specific entry in the problem list, the code window is
 518 updated to show the related line in the code.
 519
 520 Preview
 521 -------
 522
 523 Now select :guilabel:`Preview To The Side` (the |Preview| symbol on the top
 524 right) or use keyboard shortcut ``[Ctrl+k Ctrl+r]`` to open the preview window
 525 on the right hand side. This may take a few seconds. The preview shows up and
 526 renders the ``index.rst`` as it would look like on ReadTheDocs.
 527
 528 Tips and Tricks
 529 ---------------
 530
 531 The learnings are ...
 532
 533 .. tip::
 534    - Start VSC always in the ``docs`` directory of the repository. Use the
 535      command ``code .``. Then navigate via VSC's :guilabel:`Explorer`
 536      |FileExpl| to the directory which contains the file you like to edit. VSC
 537      may ask you, which ``conf.py`` VSC should use. Choose the one which
 538      resides in the directory where you have started VSC. Check also the (blue)
 539      bottom line of VSC. There you see which ``conf.py`` is currently in use.
 540      The content of ``conf.py`` affects how the documentation is presented.
 541    - VSC may claim that some packages require an update. This can be easily
 542      fixed. VSC offers automatically to install or update the package.
 543    - VSC may ask you to install ``snooty``. Please install.
 544    - Select the correct environment in the (blue) bottom line
 545      ``'onapdocs':venv``. Have also a view on the other interesting
 546      information (e.g. the ``conf.py`` which is currently in use).
 547    - First, close and reopen preview if preview is not shown properly.
 548    - Second, close and reopen VSC if preview is not shown properly.
 549    - Save your file if an error does not disappear after you have corrected it.
 550    - You can not navigate within the document structure by clicking the links
 551      in the preview. You always have to choose the correct file in the VSC
 552      :guilabel:`Explorer` window.
 553
 554 That's it!
 555 ----------
 556
 557 Congratulations, well done! You have configured a system well suited to
 558 develop ONAP documentation and to master the challenges of reStructuredText.
 559 Now have a look at all the different elements of reStructuredText and learn how
 560 to use them properly. Or maybe you like to do some optional configurations at
 561 your system first.
 562
 563 -------------------------------------------------------------------------------
 564
 565 Optional VSC Configuration
 566 ==========================
 567
 568 Add Ruler
 569 ---------
 570
 571 To add a ruler that indicates the line end at 79 characters, open
 572 :guilabel:`File` > :guilabel:`Preferences` > :guilabel:`Settings` and enter
 573 ``ruler`` in the :guilabel:`Search settings` field. In
 574 :guilabel:`Editor: Rulers` click on :guilabel:`Edit in settings.json` and add
 575 the value ``79``. The result should look like this:
 576
 577 .. code-block:: bash
 578
 579     "editor.rulers": [
 580         79
 581     ]
 582
 583 Disable Synchronized Scrolling of Editor and Preview
 584 ----------------------------------------------------
 585
 586 To disable the synchronized scrolling of editor and preview, open
 587 :guilabel:`File` > :guilabel:`Preferences` > :guilabel:`Settings` and
 588 search for ``Restructuredtext › Preview: Scroll``. Then uncheck
 589 :guilabel:`Restructuredtext › Preview: Scroll Editor With Preview` and
 590 :guilabel:`Restructuredtext › Preview: Scroll Preview With Editor`
 591
 592 -------------------------------------------------------------------------------
 593
 594 Miscellaneous
 595 =============
 596
 597 .. note:: This section is optional and should not be understood as a
 598    requirement.
 599
 600 Firefox Add-ons
 601 ---------------
 602
 603 Open :guilabel:`Add-Ons and Themes`, then search and install the following
 604 add-ons:
 605
 606 +------------------------------+-------------------------------+
 607 | I don't care about cookies   | Get rid of cookie warnings.   |
 608 +------------------------------+-------------------------------+
 609 | UBlock Origin                | A wide-spectrum blocker.      |
 610 +------------------------------+-------------------------------+
 611 | LastPass Password Manager    | Used in the Linux Foundation. |
 612 +------------------------------+-------------------------------+
 613
 614 ReText Editor
 615 -------------
 616
 617 Install this simple editor with ...
 618
 619 .. code-block:: bash
 620
 621    sudo apt install -y retext
 622
 623 -------------------------------------------------------------------------------
 624
 625 Helpful Resources
 626 =================
 627
 628 This is a collection of helpful resources if you want to extend and deepen your
 629 knowledge.
 630
 631 Documentation
 632 -------------
 633
 634 - `Write The Docs: Documentation Guide <https://www.writethedocs.org/guide>`__
 635 - `Techwriter Documatt Blog <https://techwriter.documatt.com/>`__
 636
 637 Gerrit
 638 ------
 639
 640 - `LF RelEng Gerrit Guide <https://docs.releng.linuxfoundation.org/en/latest/gerrit.html>`_
 641
 642 Git
 643 ---
 644
 645 - `LF RelEng Git Guide <https://docs.releng.linuxfoundation.org/en/latest/git.html>`__
 646 - `How To Install Git on Ubuntu 20.04 <https://www.digitalocean.com/community/tutorials/how-to-install-git-on-ubuntu-20-04>`__
 647
 648 ONAP Documentation Procedures for Developers
 649 --------------------------------------------
 650
 651 - `Procedure #1 for the ONAP Documentation Team <https://wiki.onap.org/x/-IpkBg>`__
 652 - `Procedure #2 for all other ONAP Project Teams <https://wiki.onap.org/x/w4IEBw>`__
 653
 654 Python
 655 ------
 656
 657 - `Install Python for Most Features <https://docs.restructuredtext.net/articles/prerequisites.html#install-python-for-most-features>`__
 658 - `How To Install Python 3 and Set Up a Programming Environment on an Ubuntu 20.04 Server <https://www.digitalocean.com/community/tutorials/how-to-install-python-3-and-set-up-a-programming-environment-on-an-ubuntu-20-04-server>`__
 659 - `Using Python environments in VS Code <https://code.visualstudio.com/docs/python/environments>`__
 660 - `Getting Started with Python in VS Code <https://code.visualstudio.com/docs/python/python-tutorial>`__
 661 - `Linux Foundation Docs Conf (obsolete) <https://pypi.org/project/lfdocs-conf/>`__
 662
 663 ReadTheDocs
 664 -----------
 665
 666 - `Documentation <https://docs.readthedocs.io/en/stable/>`__
 667 - `GitHub <https://github.com/readthedocs/readthedocs.org/>`__
 668
 669 ReadTheDocs Sphinx Theme
 670 ------------------------
 671
 672 - `ReadTheDocs Sphinx Theme (Recommended Reading!) <https://sphinx-rtd-theme.readthedocs.io/en/stable/>`__
 673 - `ReadTheDocs Sphinx Theme Configuration <https://sphinx-rtd-theme.readthedocs.io/en/latest/configuring.html>`__
 674
 675 reStructuredText
 676 ----------------
 677
 678 - `reStructuredText Directives <https://docutils.sourceforge.io/docs/ref/rst/directives.html>`__
 679 - `reStructuredText and Sphinx Cheat Sheet I <https://thomas-cokelaer.info/tutorials/sphinx/rest_syntax.html>`__
 680 - `reStructuredText and Sphinx Cheat Sheet II <https://docs.typo3.org/m/typo3/docs-how-to-document/master/en-us/WritingReST/CheatSheet.html>`__
 681
 682
 683 ..
 684   currently unavailable
 685   - `Online reStructuredText Editor <http://rst.ninjs.org/#>`__
 686
 687
 688 Sphinx
 689 ------
 690
 691 - `Sphinx Documentation Generator <https://www.sphinx-doc.org/en/master/>`__
 692
 693 Ubuntu
 694 ------
 695
 696 - `Virtualized Ubuntu Desktop Edition <https://linuxconfig.org/ubuntu-20-04-system-requirements>`__
 697
 698 Visual Studio Code (VSC)
 699 ------------------------
 700
 701 - `VSC Basic Editing <https://code.visualstudio.com/docs/editor/codebasics>`__
 702 - `Code Formatting with Prettier in Visual Studio Code <https://www.digitalocean.com/community/tutorials/code-formatting-with-prettier-in-visual-studio-code>`__
 703 - `VSC Icons <https://github.com/microsoft/vscode-icons>`__
 704 - `reStructuredText Extension <https://docs.restructuredtext.net/>`__
 705
 706 -------------------------------------------------------------------------------
 707
 708 Backlog
 709 =======
 710
 711 There are still some open topics or issues in this guide. They are subject
 712 for one of the upcoming releases.
 713
 714  - consider ``pandoc`` in this guide?
 715  - VSC / reStructuredText Extension Settings / reStructuredText: Sphinx Build
 716    Path: ${workspaceRoot} , ${workspaceFolder} , any alternatives?
 717  - VSC extension configuration: Difference between "Workspace" and "User"?
 718  - link to full ``ssh`` install/config?
 719  - link to full ``git`` install/config?
 720  - how to limit line width to improve readability? setting in conf.py?
 721  - keyboard shortcut ``[Ctrl+Shift+X]`` or :kbd:`Ctrl` + :kbd:`Shift` +
 722    :kbd:`X` Is this a problem in the RTD theme?
 723  - use ``menuselection``
 724    :menuselection:`My --> Software --> Some menu --> Some sub menu 1`?
 725  - evaluate and add VSC extension to "draw" tables in an aided way
 726  - add infos for config files, e.g. ``conf.py``, ``conf.yaml``
 727  - find the reason for VSC error message
 728    ``Substitution definition "ShowApp" empty or invalid.``
 729  - find the reason for VSC error message
 730    ``Unexpected indentation``
 731  - find a solution to wrap lines in VSC automatically (79 chars limit)
 732  - evaluate ``snooty`` and describe functionality (build in? not a extension?)
 733  - add a table explaining the role of installed packages/extensions in every
 734    section
 735  - update instructions to enable use of latest reStructuredText VSC extension
 736
 737 ..
 738    #########################################################################
 739    EMBEDDED PICTURES & ICONS BELOW
 740    #########################################################################
 741
 742 .. |ShowApp| image:: ./media/view-app-grid-symbolic.svg
 743    :width: 20
 744
 745 .. |Preview| image:: ./media/PreviewOnRightPane_16x.svg
 746    :width: 20
 747
 748 .. |FileExpl| image:: ./media/files.svg
 749    :width: 20
 750
 751 .. |GearSymb| image:: ./media/gear.svg
 752    :width: 20