diff --git a/.github/actions/generate_module_docs/action.yaml b/.github/actions/generate_module_docs/action.yaml deleted file mode 100644 index 35056282e..000000000 --- a/.github/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/.github/actions/generate_module_docs/generate_module_dox.py b/.github/actions/generate_module_docs/generate_module_dox.py deleted file mode 100644 index 3d50a1ab6..000000000 --- a/.github/actions/generate_module_docs/generate_module_dox.py +++ /dev/null @@ -1,48 +0,0 @@ -import os -import sys -import importlib -"""This script will generate the module api documentation for a plugin library. - -Usage ------ - -:: - - usage: generate_module_dox.py library_name - - positional arguments: - library_name The name of the library for which the documentation is - supposed to be generated. - -This script checks that only one library name is passed and that it can import -pluginplay and the library specified. If the library is a plugin, a module -manager is constructed and the modules of the library are loaded into it. -The document_modules function is called on the manager. -""" - -if __name__ == "__main__": - # Exit if more than a single argument is passed - if len(sys.argv) != 2: - sys.exit() - target = sys.argv[1].replace("_cxx_api", "") - - # Add paths to libraries - cwd = os.getcwd() - build_dir = os.path.join(cwd, "build") - pluginplay_dir = os.path.join(cwd, "build", "_deps", "pluginplay-build") - sys.path.append(build_dir) - sys.path.append(pluginplay_dir) - - # Exit on any exception - try: - pluginplay = importlib.import_module("pluginplay") - library = importlib.import_module(target) - # If this library is a plugin, try to print the dox. - if hasattr(library, "load_modules"): - mm = pluginplay.ModuleManager() - library.load_modules(mm) - # This is no-op if docs/source/module_api doesn't exist - pluginplay.document_modules(mm, "docs/source/module_api") - except Exception as e: - print(f"An exception caught: {e}") - sys.exit() diff --git a/.github/workflows/merge.yaml b/.github/workflows/merge.yaml index eb1831f62..8083f6579 100644 --- a/.github/workflows/merge.yaml +++ b/.github/workflows/merge.yaml @@ -13,7 +13,7 @@ # limitations under the License. # -name: .github Merge Workflow +name: Merge Workflow on: push: @@ -21,9 +21,12 @@ on: - master jobs: - Common-Merge: - uses: NWChemEx/.github/.github/workflows/common_merge.yaml@master + tag-commit: + uses: NWChemEx/.github/.github/workflows/tag.yaml@master + secrets: inherit + + deploy_nwx_docs: + uses: NWChemEx/.github/.github/workflows/deploy_nwx_docs.yaml@master with: - doc_target: 'pluginplay_cxx_api' - generate_module_docs: false + doc_target: "pluginplay_cxx_api" secrets: inherit diff --git a/.github/workflows/pull_request.yaml b/.github/workflows/pull_request.yaml index 8be78b7ff..7ff47b345 100644 --- a/.github/workflows/pull_request.yaml +++ b/.github/workflows/pull_request.yaml @@ -13,7 +13,7 @@ # limitations under the License. # -name: .github Pull Request Workflow +name: Pull Request Workflow on: pull_request: @@ -21,11 +21,17 @@ on: - master jobs: - Common-Pull-Request: - uses: NWChemEx/.github/.github/workflows/common_pull_request.yaml@master + check_formatting: + uses: NWChemEx/.github/.github/workflows/check_formatting.yaml@master + with: + license_config: ".github/.licenserc.yaml" + + test_nwx_docs: + uses: NWChemEx/.github/.github/workflows/test_nwx_docs.yaml@master + with: + doc_target: "pluginplay_cxx_api" + + test_library: + uses: NWChemEx/.github/.github/workflows/test_nwx_library.yaml@master with: - config_file: '.github/.licenserc.yaml' - source_dir: 'include src tests' compilers: '["gcc-11", "clang-14"]' - doc_target: 'pluginplay_cxx_api' - secrets: inherit \ No newline at end of file