Repository navigation
Conversation
Co-Authored-By: Patrick Lehmann <Paebbels@gmail.com>
The license override file kept an entry for sphinx-reports, which no dependency table lists. The commented-out PDFDocumentation job named 'sphinx_reports' as its document; this documentation's LaTeX file is 'pyTooling.tex'. Co-Authored-By: Patrick Lehmann <Paebbels@gmail.com>
…ive only. The 'PublishToGitHubPages' job got the Coverage.py HTML report as input 'coverage', which it unpacks into 'coverage/' and so overwrote the documentation's 'coverage/index' page rendered by pyTooling.Sphinx. Without the input, the job skips the download. Co-Authored-By: Patrick Lehmann <Paebbels@gmail.com>
PublishCoverageResults got 'coverage_html_artifact' and 'coverage_report_html', so it ran 'coverage html' and uploaded the result - only for the PublishToGitHubPages job, which doesn't publish it anymore. The documentation's code coverage pages, rendered by pyTooling.Sphinx from coverage.json, replace it. Without the artifact name, the job skips the conversion and the upload. Co-Authored-By: Patrick Lehmann <Paebbels@gmail.com>
…oc coverage As pyTooling/Actions#333 and pyTooling.Sphinx do: * conf.py: 'pages' for the unit test report (unittests/src), the code coverage report (coverage/src, with 'sources' for the listings) and the doc coverage report (doccoverage/src) - a page per testsuite/testcase, per module and file, generated by pyTooling.Sphinx. * coverage/index.rst is the code coverage page (label CODECOV) with its legend; CodeCoverage.rst is removed - it repeated the summary. * DocCoverage.rst moves to doccoverage/index.rst (label DOCCOV), so its pages sit below it as for the other two reports. * index.rst: the 'References and Reports' toctree lists the three report pages. A local build with a merged JUnit report (as PublishTestResults writes it) and coverage.json: 4277 unit test pages, 114 code coverage pages, 72 doc coverage pages, no error. Co-Authored-By: Patrick Lehmann <Paebbels@gmail.com>
The previous commit holds only the removal of CodeCoverage.rst and the move of DocCoverage.rst: its 'git add' named the moved files by their old paths, so the edits it describes weren't staged. They follow here: 'pages' (and 'sources') in conf.py, coverage/index.rst with the legend, the label DOCCOV and title of doccoverage/index.rst, and the toctree in index.rst. Co-Authored-By: Patrick Lehmann <Paebbels@gmail.com>
Up to standards ✅🟢 Issues
|
| Metric | Results |
|---|---|
| Complexity | 0 |
| Duplication | 0 |
NEW Get contextual insights on your PRs based on Codacy's metrics, along with PR and Jira context, without leaving GitHub. Enable AI reviewer
TIP This summary will be updated as you push new changes.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #682 +/- ##
=======================================
Coverage 90.20% 90.20%
=======================================
Files 66 66
Lines 18478 18478
Branches 2879 2879
=======================================
Hits 16668 16668
Misses 1361 1361
Partials 449 449
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
pyTooling.Dependency.Python reads license overrides from a YAML file (LicenseOverrides.FromFile), through pyTooling.Configuration.YAML, which needs ruamel.yaml. The extra 'dependencies' didn't name it, so a project installing pyTooling[dependencies] - e.g. pyTooling.Sphinx for its dependency tables - failed with "Optional dependency 'ruamel.yaml' not installed." when it read its overrides file, unless ruamel.yaml came in another way. The extra now requires 'ruamel.yaml ~= 0.19', as the extra 'yaml' does; the documentation of pyTooling.Dependency.Python names it. Co-Authored-By: Patrick Lehmann <Paebbels@gmail.com>
Co-Authored-By: Patrick Lehmann <Paebbels@gmail.com>
This was referenced Oct 29, 2026
This was referenced Oct 29, 2026
Open
This was referenced Oct 29, 2026
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Note
A patch release after v10.1.0 (#675).
dependenciesincludes ruamel.yaml, which reading a license overrides file needs - documentation builds with pyTooling.Sphinx 1.0 and aDependency.PackageOverrides.yamlfailed without it.🪳 Bug Fixes
dependencies: it didn't includeruamel.yaml, whichpyTooling.Dependency.Python.LicenseOverrides.FromFile()needs to read license overrides from a YAML file (throughpyTooling.Configuration.YAML). A project installing onlypyTooling[dependencies]failed withMissingDependencyError: Optional dependency 'ruamel.yaml' not installed.when it read such a file - e.g. every documentation build with pyTooling.Sphinx 1.0 whoseconf.pysetspyTooling_Dependency_PackageOverridesand whose requirements don't bring ruamel.yaml in another way. The extra now requiresruamel.yaml ~= 0.19, as the extrayamldoes. (Extra 'dependencies' includes ruamel.yaml (license overrides file) #684)📖 Documentation
doc/coverage/index.rst(labelCODECOV) replacesdoc/CodeCoverage.rst; the documentation coverage page moves todoc/doccoverage/index.rst(labelDOCCOV). (Documentation: report pages of pyTooling.Sphinx; no Coverage.py HTML report #683)pyTooling.Dependency.Pythonnames ruamel.yaml for reading license overrides. (Extra 'dependencies' includes ruamel.yaml (license overrides file) #684)⚙️ GitHub Pipeline
PublishToGitHubPagesunpacked it intocoverage/and so overwrote the code coverage page rendered by pyTooling.Sphinx. (Documentation: report pages of pyTooling.Sphinx; no Coverage.py HTML report #683)Others
10.1.1.Related Issues and Pull-Requests
dependenciesgets the ruamel.yaml packages.Duration, Stopwatch: split times as Duration, kept in nanoseconds #678).