testing CI basic features #50
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
| --- | |
| # Automates building of python docs via sphinx | |
| name: ci-doc-build | |
| # Define the events that trigger the workflow | |
| on: | |
| push: | |
| branches: | |
| # You can change the default value as needed | |
| - '*' | |
| workflow_dispatch: | |
| # Define the jobs in the workflow | |
| jobs: | |
| build-doc: | |
| runs-on: ubuntu-latest | |
| # You can change the default value as needed | |
| env: | |
| # Directory of docs | |
| doc-directory: ./docs | |
| # Define strategy for matrix builds | |
| strategy: | |
| matrix: | |
| # You can change the default value as needed | |
| python-version: ['3.9'] | |
| steps: | |
| # Step: Check out the repository's code to the runner | |
| - name: checkout-code | |
| uses: actions/checkout@v3 | |
| # Step: Set up Python environment | |
| - name: setup-python-env ${{ matrix.python-version }} | |
| uses: actions/setup-python@v4 | |
| with: | |
| python-version: ${{ matrix.python-version }} | |
| # Step: Install project dependencies using pip | |
| - name: install-dependencies | |
| run: | | |
| python -m pip install --upgrade pip setuptools wheel | |
| python -m pip install . | |
| python -m pip install ".[docs]" | |
| # Modify the name inside the brackets to match the name of the | |
| # extras_require you would like to install. There should be no | |
| # whitespaces inside the brackets. e.g. python -m pip install-e | |
| # ".[dev,docs]" | |
| # Step: Clean previous build to remove deprecated files before building | |
| - name: clean-previous-build | |
| working-directory: ${{env.doc-directory}} | |
| run: rm -rf ./build | |
| # Step: Build documentation with Sphinx | |
| - name: build-doc | |
| working-directory: ${{env.doc-directory}} | |
| run: make html | |
| # Step: List files in doc build directory | |
| - name: list-files-doc-build | |
| working-directory: ${{env.doc-directory}} | |
| run: | | |
| directory="./build/html" | |
| ls "$directory" | |
| # Step: Check if necessary files exist in the list You can change the | |
| # default value of the list as needed | |
| - name: check-files-doc-build | |
| working-directory: ${{env.doc-directory}} | |
| run: | | |
| directory="./build/html" | |
| required_files=("index.html" "browse.html") | |
| missing_files=() | |
| for file in "${required_files[@]}"; do | |
| if [[ ! -f "$directory/$file" ]]; then | |
| missing_files+=("$file") | |
| fi | |
| done | |
| if [[ ${#missing_files[@]} -gt 0 ]]; then | |
| echo "These files are missing in '$directory': ${missing_files[*]}" | |
| exit 1 | |
| fi |