-
Notifications
You must be signed in to change notification settings - Fork 6
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merged Code Coverage and Python 3.12
- Loading branch information
Showing
45 changed files
with
1,371 additions
and
363 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
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,67 @@ | ||
| # ==================================================================================================================== # | ||
| # Authors: # | ||
| # Patrick Lehmann # | ||
| # # | ||
| # ==================================================================================================================== # | ||
| # Copyright 2020-2024 The pyTooling Authors # | ||
| # # | ||
| # 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. # | ||
| # # | ||
| # SPDX-License-Identifier: Apache-2.0 # | ||
| # ==================================================================================================================== # | ||
| name: Check Documentation | ||
|
|
||
| on: | ||
| workflow_call: | ||
| inputs: | ||
| python_version: | ||
| description: 'Python version.' | ||
| required: false | ||
| default: '3.12' | ||
| type: string | ||
| directory: | ||
| description: 'Source code directory to check.' | ||
| required: true | ||
| type: string | ||
| # fail_below: | ||
| # description: 'Minimum required documentation coverage level' | ||
| # required: false | ||
| # default: 75 | ||
| # type: string | ||
|
|
||
| jobs: | ||
| DocCoverage: | ||
| name: 👀 Check documentation coverage | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - name: ⏬ Checkout repository | ||
| uses: actions/checkout@v4 | ||
|
|
||
| - name: 🐍 Setup Python 3.11 | ||
| uses: actions/setup-python@v5 | ||
| with: | ||
| python-version: "3.11" | ||
|
|
||
| - name: 🔧 Install wheel,tomli and pip dependencies (native) | ||
| run: | | ||
| python -m pip install --disable-pip-version-check -U docstr_coverage interrogate | ||
| - name: Run 'interrogate' Documentation Coverage Check | ||
| continue-on-error: true | ||
| run: | | ||
| interrogate -c pyproject.toml | ||
| - name: Run 'docstr_coverage' Documentation Coverage Check | ||
| continue-on-error: true | ||
| run: | | ||
| docstr_coverage -v ${{ inputs.directory }} |
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,66 @@ | ||
| # ==================================================================================================================== # | ||
| # Authors: # | ||
| # Patrick Lehmann # | ||
| # # | ||
| # ==================================================================================================================== # | ||
| # Copyright 2020-2024 The pyTooling Authors # | ||
| # # | ||
| # 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. # | ||
| # # | ||
| # SPDX-License-Identifier: Apache-2.0 # | ||
| # ==================================================================================================================== # | ||
| name: LaTeX Documentation | ||
|
|
||
| on: | ||
| workflow_call: | ||
| inputs: | ||
| document: | ||
| description: 'LaTeX root document without *.tex extension.' | ||
| required: true | ||
| type: string | ||
| latex_artifact: | ||
| description: 'Name of the LaTeX documentation artifact.' | ||
| required: false | ||
| default: '' | ||
| type: string | ||
| pdf_artifact: | ||
| description: 'Name of the PDF documentation artifact.' | ||
| required: false | ||
| default: '' | ||
| type: string | ||
|
|
||
| jobs: | ||
| PDFDocumentation: | ||
| name: 📓 Converting LaTeX Documentation to PDF | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - name: 📥 Download artifacts '${{ inputs.latex_artifact }}' from 'SphinxDocumentation' job | ||
| uses: actions/download-artifact@v4 | ||
| with: | ||
| name: ${{ inputs.latex_artifact }} | ||
| path: latex | ||
|
|
||
| - name: Compile LaTeX document | ||
| uses: xu-cheng/latex-action@master | ||
| with: | ||
| working_directory: latex | ||
| root_file: ${{ inputs.document }}.tex | ||
|
|
||
| - name: 📤 Upload 'PDF Documentation' artifact | ||
| uses: actions/upload-artifact@v4 | ||
| if: inputs.pdf_artifact != '' | ||
| with: | ||
| name: ${{ inputs.pdf_artifact }} | ||
| path: ${{ inputs.document }}.pdf | ||
| if-no-files-found: error | ||
| retention-days: 1 |
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.