From 2ebfade4c5b2ceb71ff58b8ce44a25893cafef43 Mon Sep 17 00:00:00 2001 From: "Jonathan M. Waldrop" Date: Tue, 21 Nov 2023 15:22:52 -0600 Subject: [PATCH] move module doc generation script to docker image --- .github/workflows/common_merge.yaml | 4 +-- actions/generate_module_docs/action.yaml | 31 ------------------- nwx_build_environment/nwx_buildenv.dockerfile | 1 + .../scripts}/generate_module_dox.py | 0 4 files changed, 2 insertions(+), 34 deletions(-) delete mode 100644 actions/generate_module_docs/action.yaml rename {actions/generate_module_docs => nwx_build_environment/scripts}/generate_module_dox.py (100%) diff --git a/.github/workflows/common_merge.yaml b/.github/workflows/common_merge.yaml index 9aeb3bc..cde509c 100644 --- a/.github/workflows/common_merge.yaml +++ b/.github/workflows/common_merge.yaml @@ -102,9 +102,7 @@ jobs: # Generate the module docs source files - name: Generate Module Docs if: inputs.generate_module_docs == true - uses: NWChemEx-Project/.github/actions/generate_module_docs@master - with: - doc_target: $${{ inputs.doc_target }} + runs: python3 /scripts/generate_module_dox.py $${{ inputs.doc_target }} # Build the Sphinx docs and then deploy - name: Sphinx Docs run: | diff --git a/actions/generate_module_docs/action.yaml b/actions/generate_module_docs/action.yaml deleted file mode 100644 index 3505628..0000000 --- a/actions/generate_module_docs/action.yaml +++ /dev/null @@ -1,31 +0,0 @@ -# Copyright 2023 NWChemEx-Project -# -# 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 -# -# http://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. -# - -name: Generate Module Docs - -inputs: - doc_target: - description: "The name of the documentation target." - type: string - required: false - default: '' - -runs: - using: "composite" - steps: - - name: Generate Module Documentation - run: | - python3 ${{github.action_path}}/generate_module_dox.py ${{inputs.doc_target}} - shell: bash diff --git a/nwx_build_environment/nwx_buildenv.dockerfile b/nwx_build_environment/nwx_buildenv.dockerfile index 335ac25..b04b563 100644 --- a/nwx_build_environment/nwx_buildenv.dockerfile +++ b/nwx_build_environment/nwx_buildenv.dockerfile @@ -26,4 +26,5 @@ RUN apt-get update \ && apt-get clean && rm -rf /var/lib/apt/lists/* COPY toolchains /toolchains +COPY scripts /scripts diff --git a/actions/generate_module_docs/generate_module_dox.py b/nwx_build_environment/scripts/generate_module_dox.py similarity index 100% rename from actions/generate_module_docs/generate_module_dox.py rename to nwx_build_environment/scripts/generate_module_dox.py