Gotchas zur Doku-Umgebung

UnauthorizedAccess bei Powershell-Scripten

Fehler

Die Datei "C:\Users\...\PycharmProjects\...\venv\Scripts\activate.ps1" kann nicht geladen werden,
da die Ausführung von Skripts auf diesem System deaktiviert ist. Weitere Informationen finden Sie
unter "about_Execution_Policies" (https:/go.microsoft.com/fwlink/?LinkID=135170).
    + CategoryInfo          : Sicherheitsfehler: (:) [], ParentContainsErrorRecordException
    + FullyQualifiedErrorId : UnauthorizedAccess

Lösung

> Set-ExecutionPolicy -ExecutionPolicy Unrestricted -Scope CurrentUser
> Get-ExecutionPolicy -list

        Scope ExecutionPolicy
        ----- ---------------
MachinePolicy       Undefined
   UserPolicy       Undefined
      Process       Undefined
  CurrentUser    Unrestricted
 LocalMachine       Undefined

Sphinx: Requirements installieren

> .\venv\Scripts\activate.ps1
> pip install -r .\requirements.txt

Sphinx: Erzeugen der Dokumente

# Erzeugen der Dokumente im Build
.\make.bat html

# Starten eines lokalen Webservers
python -m http.server --directory build/html 3000

Dann: lokaler Test-Server unter http://localhost:3000

Doku-Umgebung in VSCode unter Windows 10 konfigurieren

Virtual-Environment erzeugen: und aktivieren
PS H:\Users\nebel....> python.exe -m venv venv
PS H:\Users\nebel....> .\venv\Scripts\Activate.ps1
Python-Bibliotheken aus den requirements installieren
(venv) PS H:\Users\nebel.....> pip install -r .\requirements.txt
Collecting Sphinx
.... (gekürzt)
Installing collected packages: sphinx-bootstrap-theme, snowballstemmer, pytz, alabaster, waitress, urllib3, sphinxcontrib-serializinghtml, sphinxcontrib-qthelp, sphinxcontrib-jsmath, sphinxcontrib-htmlhelp, sphinxcontrib-devhelp, sphinxcontrib-applehelp, pyparsing, pygments, MarkupSafe, itsdangerous, imagesize, idna, docutils, colorama, charset-normalizer, certifi, babel, werkzeug, requests, packaging, Jinja2, click, Sphinx, flask, sphinx-tabs
Successfully installed Jinja2-3.1.2 MarkupSafe-2.1.1 Sphinx-5.1.1 alabaster-0.7.12 babel-2.10.3 certifi-2022.6.15 charset-normalizer-2.1.1 click-8.1.3 colorama-0.4.5 docutils-0.18.1 flask-2.2.2 idna-3.3 imagesize-1.4.1 itsdangerous-2.1.2 packaging-21.3 pygments-2.13.0 pyparsing-3.0.9 pytz-2022.2.1 requests-2.28.1 snowballstemmer-2.2.0 sphinx-bootstrap-theme-0.8.1 sphinx-tabs-3.4.1 sphinxcontrib-applehelp-1.0.2 sphinxcontrib-devhelp-1.0.2 sphinxcontrib-htmlhelp-2.0.0 sphinxcontrib-jsmath-1.0.1 sphinxcontrib-qthelp-1.0.3 sphinxcontrib-serializinghtml-1.1.5 urllib3-1.26.12 waitress-2.1.2 werkzeug-2.2.2

[notice] A new release of pip available: 22.2.1 -> 22.2.2
[notice] To update, run: python.exe -m pip install --upgrade pip
Spinx-Layouten und lokalen Webserver starten
(venv) PS H:\Users\nebel.....> .\make.bat html ; python -m http.server --directory build/html 3000
Sphinx v5.1.1 in Verwendung
Lade Übersetzungen [de_DE]…erledigt
making output directory... erledigt
building [mo]: targets for 0 po files that are out of Datei
.... (gekürzt)
dumping search index in German (code: de)... erledigt
dumping object inventory... erledigt

====================== slowest reading durations =======================
0.043 godot_einfuehrung/index
0.039 devumgebung/notes
0.016 godot_einfuehrung/beispiel_projekt/step_02
0.015 godot_einfuehrung/beispiel_projekt/step_10
0.011 index
build abgeschlossen.

The HTML pages are in build\html.
Serving HTTP on :: port 3000 (http://[::]:3000/) ...
::ffff:127.0.0.1 - - [29/Aug/2022 18:59:07] "GET / HTTP/1.1" 200 -
::ffff:127.0.0.1 - - [29/Aug/2022 18:59:08] "GET /_static/pygments.css HTTP/1.1" 200 -
::ffff:127.0.0.1 - - [29/Aug/2022 18:59:08] "GET /_static/bootstrap-sphinx.css HTTP/1.1" 200 -
::ffff:127.0.0.1 - - [29/Aug/2022 18:59:08] "GET /_static/tabs.css HTTP/1.1" 200 -
.... (gekürzt)