-
Notifications
You must be signed in to change notification settings - Fork 9
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #346 from Exawind/revise-docs
Revise openturbine documentation
- Loading branch information
Showing
42 changed files
with
2,556 additions
and
892 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,62 @@ | ||
| name: Deploy OpenTurbine Documentation | ||
|
|
||
| on: | ||
| push: | ||
| branches: [main] | ||
| pull_request: | ||
| branches: [main] | ||
|
|
||
| concurrency: | ||
| group: ${{github.ref}}-${{github.head_ref}}-docs | ||
| cancel-in-progress: true | ||
|
|
||
| jobs: | ||
| Deploy-Docs: | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - name: Cache install source dependencies | ||
| id: cache-dependencies | ||
| uses: actions/cache@v3 | ||
| with: | ||
| path: ${{ github.workspace }}/spack | ||
| key: linux-spack | ||
| - name: Install source dependencies | ||
| if: steps.cache-dependencies.outputs.cache-hit != 'true' | ||
| run: | | ||
| git clone https://github.com/spack/spack.git | ||
| source spack/share/spack/setup-env.sh | ||
| spack compiler find | ||
| spack install yaml-cpp | ||
| spack install trilinos@master~epetra ^kokkos-kernels+blas+lapack | ||
| - name: Set up Python | ||
| uses: actions/setup-python@v5 | ||
| with: | ||
| python-version: '3.12' | ||
| - name: Clone repository | ||
| uses: actions/checkout@v4 | ||
| with: | ||
| path: openturbine | ||
| - name: Install documentation dependencies | ||
| run: | | ||
| sudo apt-get update | ||
| sudo apt-get install -y --no-install-recommends graphviz libenchant-2-dev doxygen | ||
| python3 -m pip install --upgrade pip | ||
| pip install -r openturbine/docs/requirements.txt | ||
| - name: Build OpenTurbine with documentation | ||
| run: | | ||
| source spack/share/spack/setup-env.sh | ||
| spack load trilinos yaml-cpp | ||
| cd openturbine | ||
| mkdir build | ||
| cd build | ||
| cmake .. \ | ||
| -DOpenTurbine_ENABLE_TESTS=OFF \ | ||
| -DOpenTurbine_ENABLE_DOCUMENTATION=ON \ | ||
| -DCMAKE_BUILD_TYPE=Release | ||
| cmake --build . | ||
| - name: Deploy documentation | ||
| if: github.event_name == 'push' && github.ref == 'refs/heads/main' | ||
| uses: peaceiris/actions-gh-pages@v4 | ||
| with: | ||
| github_token: ${{ secrets.GITHUB_TOKEN }} | ||
| publish_dir: ${{ github.workspace }}/openturbine/build/docs/sphinx/html |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,26 @@ | ||
| #---------------------------------------------------------------------------------------- | ||
| # Finds the Doxysphinx executable and version required for generating Sphinx-compatible | ||
| # documentation from Doxygen outputs | ||
| #---------------------------------------------------------------------------------------- | ||
| find_program(DOXYSPHINX_EXECUTABLE NAMES doxysphinx | ||
| DOC "Doxysphinx Documentation Builder" | ||
| ) | ||
|
|
||
| if(DOXYSPHINX_EXECUTABLE) | ||
| execute_process( | ||
| COMMAND ${DOXYSPHINX_EXECUTABLE} --version | ||
| OUTPUT_VARIABLE DOXYSPHINX_VERSION_OUTPUT | ||
| OUTPUT_STRIP_TRAILING_WHITESPACE | ||
| ) | ||
| if("${DOXYSPHINX_VERSION_OUTPUT}" MATCHES "version ([0-9]+\\.[0-9]+\\.[0-9]+)") | ||
| set(DOXYSPHINX_VERSION "${CMAKE_MATCH_1}") | ||
| endif() | ||
| endif() | ||
|
|
||
| include(FindPackageHandleStandardArgs) | ||
| find_package_handle_standard_args(Doxysphinx | ||
| REQUIRED_VARS DOXYSPHINX_EXECUTABLE | ||
| VERSION_VAR DOXYSPHINX_VERSION | ||
| ) | ||
|
|
||
| mark_as_advanced(DOXYSPHINX_EXECUTABLE) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,25 @@ | ||
| #---------------------------------------------------------------------------------------- | ||
| # Finds the Sphinx documentation builder and its version | ||
| #---------------------------------------------------------------------------------------- | ||
| find_program(SPHINX_EXECUTABLE NAMES sphinx-build | ||
| DOC "Sphinx Documentation Builder (sphinx-doc.org)" | ||
| ) | ||
|
|
||
| if(SPHINX_EXECUTABLE) | ||
| execute_process( | ||
| COMMAND ${SPHINX_EXECUTABLE} --version | ||
| OUTPUT_VARIABLE SPHINX_VERSION_OUTPUT | ||
| OUTPUT_STRIP_TRAILING_WHITESPACE | ||
| ) | ||
| if("${SPHINX_VERSION_OUTPUT}" MATCHES ".* ([^\n]+)\n") | ||
| set(SPHINX_VERSION "${CMAKE_MATCH_1}") | ||
| endif() | ||
| endif() | ||
|
|
||
| include(FindPackageHandleStandardArgs) | ||
| find_package_handle_standard_args(Sphinx | ||
| REQUIRED_VARS SPHINX_EXECUTABLE | ||
| VERSION_VAR SPHINX_VERSION | ||
| ) | ||
|
|
||
| mark_as_advanced(SPHINX_EXECUTABLE) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.