Merge pull request #442 from common-workflow-language/cleanups

GH-Pages: render multiple languages

Author: mr-c

.github/workflows/gh-pages.yaml

@@ -25,30 +25,20 @@ jobs:
         uses: actions/setup-python@v4
         with:
           python-version: '3.9'
+          cache: pip
 
-      - name: Upgrade pip
-        run: |
-          # pip >= 20.1 so we can use ``pip cache dir``
-          python3 -m pip install --upgrade pip
-      - name: Get pip cache dir
-        id: pip-cache
-        run: echo "dir=$(pip cache dir)" >> "$GITHUB_OUTPUT"
-
-      - name: Cache dependencies
-        uses: actions/cache@v3
-        with:
-          path: ${{ steps.pip-cache.outputs.dir }}
-          key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements.txt') }}
-          restore-keys: |
-            ${{ runner.os }}-pip-
       - name: Install dependencies
         run: python3 -m pip install -U -e ".[all]"
 
       - name: pre-pull container images
         run: make container-pull
 
       - name: Build documentation
-        run: make html
+        run: |
+          make html
+          for lang in en es pt_BR pt_PT ja zh_Hans; do
+            make html BUILDDIR=_build/${lang} SPHINXOPTS="-D language=${lang}"
+          done
 
       - name: Deploy
         uses: peaceiris/actions-gh-pages@v3

Makefile

@@ -3,7 +3,7 @@
 
 # You can set these variables from the command line, and also
 # from the environment for the first two.
-#SPHINXOPTS		=   # was "-W" (turn warnings into errors)
+SPHINXOPTS		=   # was "-W" (turn warnings into errors)
 SPHINXBUILD		= sphinx-build
 SOURCEDIR		= src
 BUILDDIR		= _build

src/conf.py

@@ -218,7 +218,8 @@
     "navigation_depth": 2,
     "collapse_navigation": True,
     "show_prev_next": True,
-    "footer_items": ["copyright"],
+    "footer_start": ["copyright", "sphinx-version"],
+    "footer_end": ["theme-version"],
 }
 
 html_context = {

src/introduction/prerequisites.md

@@ -141,8 +141,8 @@ rest of the file.
 The *shebang* is the two-character sequence `#!` at the beginning of a
 script. When the script is executable, the operating system will execute
 the script using the executable specified after the shebang. It is
-considered a good practice to use `/usr/bin/env <executable>` rather than using a hard-coded location, since `/usr/bin/env <executable>`
-looks for the `<executable>` program in the system `PATH`,
+considered a good practice to use `/usr/bin/env [executable]` rather than using a hard-coded location, since `/usr/bin/env [executable]`
+looks for the `[executable]` program in the system `PATH`,
 ```
 
 ## Text Editor

src/introduction/quick-start.md

@@ -51,7 +51,7 @@ of software and libraries used for following the rest of this user guide.
 ## Running "Hello World"
 
 The usage of the `cwltool` command-line executable is basically
-`cwltool [OPTIONS] <CWL_DOCUMENT> [INPUTS_OBJECT]`. You can run the
+`cwltool [OPTIONS] [CWL_DOCUMENT] [INPUTS_OBJECT]`. You can run the
 `hello_world.cwl` workflow without specifying any option:
 
 ```{runcmd} cwltool hello_world.cwl