docs: hide a title on the API Reference page #1408
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
| # The MIT License (MIT) | |
| # | |
| # Copyright (c) 2018 Mateusz Pusz | |
| # | |
| # Permission is hereby granted, free of charge, to any person obtaining a copy | |
| # of this software and associated documentation files (the "Software"), to deal | |
| # in the Software without restriction, including without limitation the rights | |
| # to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | |
| # copies of the Software, and to permit persons to whom the Software is | |
| # furnished to do so, subject to the following conditions: | |
| # | |
| # The above copyright notice and this permission notice shall be included in all | |
| # copies or substantial portions of the Software. | |
| # | |
| # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | |
| # IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | |
| # FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | |
| # AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | |
| # LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | |
| # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | |
| # SOFTWARE. | |
| name: Documentation | |
| on: | |
| push: | |
| branches: | |
| - master | |
| - main | |
| permissions: | |
| contents: write | |
| jobs: | |
| deploy: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| with: | |
| fetch-depth: 0 | |
| - uses: actions/setup-python@v5 | |
| with: | |
| python-version: 3.x | |
| - run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV | |
| - uses: actions/cache@v4 | |
| with: | |
| key: mkdocs-material-${{ env.cache_id }} | |
| path: .cache | |
| restore-keys: | | |
| mkdocs-material- | |
| - name: Prepare git | |
| run: | | |
| git config --global user.name github-actions | |
| git config --global user.email [email protected] | |
| git fetch origin gh-pages --depth=1 | |
| - name: Installing API reference dependencies | |
| run: | | |
| sudo apt update | |
| sudo apt install latexmk texlive-latex-recommended texlive-latex-extra texlive-fonts-recommended lmodern | |
| sudo apt install haskell-stack graphviz nodejs npm ghc cabal-install | |
| npm install split mathjax-full mathjax-node-sre mathjax-node-cli | |
| cabal update | |
| echo "${{ github.workspace }}/node_modules/.bin" >> $GITHUB_PATH | |
| - name: Get git repos with API reference tools | |
| run: | | |
| git clone https://github.com/JohelEGP/jegp.cmake_modules.git --depth=1 | |
| git clone https://github.com/JohelEGP/draft.git --branch=standardese_sources_base --depth=1 | |
| git clone https://github.com/JohelEGP/cxxdraft-htmlgen.git --branch=standardese_sources_base --depth=1 | |
| - name: Generate API reference | |
| run: | | |
| cmake -S docs/api_reference/src -B build \ | |
| -DCMAKE_MODULE_PATH="${{ github.workspace }}/jegp.cmake_modules/modules" \ | |
| -DJEGP_STANDARDESE_SOURCES_GIT_REPOSITORY="${{ github.workspace }}/draft" \ | |
| -DJEGP_CXXDRAFT_HTMLGEN_GIT_REPOSITORY="${{ github.workspace }}/cxxdraft-htmlgen" | |
| cmake --build build | |
| mv build/mp-units.html docs/api_reference/gen | |
| - name: Installing pip dependencies | |
| run: | | |
| pip install conan mkdocs-material mkdocs-rss-plugin mkdocs-material[imaging] mkdocs-exclude mike | |
| - name: Building docs | |
| run: | | |
| mike deploy --push --update-aliases `conan inspect . | sed -n -r 's/version: ([0-9]+.[0-9]+).[0-9]+/\1/p'` latest |