Introduce script and action step to build documentation (#2460)

* Mechanical reformat of .github/workflows

By https://marketplace.visualstudio.com/items?itemName=GitHub.vscode-github-actions

* Introduce script and action step to build documentation

---------

Co-authored-by: Jing Tang <[email protected]>

.github/workflows/build.yml

@@ -94,3 +94,8 @@ jobs:
  with:
  name: build
  path: build.zip
+
+ # Steps that follow are related to the Documentation Web Site
+
+ - name: Build Docs Site
+ run: ./build-docs.bash

.gitignore

@@ -14,6 +14,7 @@
 bin/
 gen/
 out/
+
 # Uncomment the following line in case you need and you don't have the release build type files in your app
 # release/
 
@@ -40,13 +41,14 @@ captures/
 *.iml
 .idea
 
-# VSCode/Eclipse 
+# VSCode/Eclipse
 .classpath
 .project
 .settings
 
 # Keystore files
 # Uncomment the following lines if you do not want to check your keystore files in.
+# (Please carefully consider the security implications of doing so! ASK, if unclear.)
 #*.jks
 #*.keystore
 
@@ -55,6 +57,8 @@ captures/
 .cxx/
 
 # Google Services (e.g. APIs or Firebase)
+# (Because this file contains secret credentials, like passwords;
+# please carefully consider the security implications of doing so! ASK, if unclear.)
 # google-services.json
 
 # Freeline
@@ -81,3 +85,8 @@ lint/tmp/
 
 # Mac OS
 .DS_Store
+
+# MkDocs Documentation Generation
+# Note: The docs/ directory is our SOURCE (in MD),
+# and the site/ directory is our TARGET (in HTML)
+site/

build-docs.bash

@@ -0,0 +1,24 @@
+#!/usr/bin/env bash
+# SPDX-License-Identifier: Apache-2.0
+#
+# Copyright 2023-2024 The Enola <https://enola.dev> Authors
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+set -euox pipefail
+
+mkdir -p site/
+
+# TODO Replace this with mkdocs generation
+# TODO Fix https://github.com/google/android-fhir/issues/2237 and generate API JavaDoc
+cp -R docs/* site/