Bump typedoc from 0.25.13 to 0.26.10 (#1016) #779
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
| # Copyright (c) 2021 Concurrent Technologies Corporation. | |
| # | |
| # 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 is 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: Deploy Documentation | |
| on: | |
| workflow_dispatch: | |
| push: | |
| branches: | |
| - main | |
| jobs: | |
| deploy-docs: | |
| runs-on: macos-14 | |
| steps: | |
| - name: Install Prerequisites 📚 | |
| run: | | |
| brew install ninja doxygen graphviz | |
| - name: Checkout Source 🛎️ | |
| uses: actions/checkout@v4 | |
| - name: Setup Python 🐍 | |
| uses: actions/setup-python@v5 | |
| with: | |
| python-version: '3.x' | |
| - name: Create Virtual Environment 🌐 | |
| run: | | |
| python -m venv venv | |
| - name: Install Python Dependencies 📦 | |
| run: | | |
| source venv/bin/activate | |
| pip install --upgrade pip | |
| pip install breathe sphinx_rtd_theme sphinx-rtd-dark-mode sphinx-sitemap sphinx | |
| - name: Prepare and Build Documentation 🔧 | |
| run: | | |
| source venv/bin/activate | |
| cmake -S . -B build -DCMAKE_BUILD_TYPE=Release -DBUILD_DOCS=ON -DBUILD_TESTS=OFF -DBUILD_EXAMPLES=OFF | |
| cmake --build build --target sphinx --config Release | |
| touch build/core/docs/sphinx/.nojekyll | |
| - name: Deploy User Documentation 🚀 | |
| uses: JamesIves/github-pages-deploy-action@v4 | |
| with: | |
| branch: gh-pages | |
| folder: build/core/docs/sphinx # The deployment folder should match the name of the artifact. |