Skip to content

DOCS: Change PyEDB documentation style #4889

DOCS: Change PyEDB documentation style

DOCS: Change PyEDB documentation style #4889

Triggered via pull request December 22, 2025 14:53
Status Cancelled
Total duration 1m 15s
Artifacts 4

ci_cd.yml

on: pull_request
Matrix: smoke-tests
Test dotnet (windows)
46s
Test dotnet (windows)
Test grpc (windows)
0s
Test grpc (windows)
Unit test dotnet (windows)
40s
Unit test dotnet (windows)
Unit test grpc (windows)
0s
Unit test grpc (windows)
Test dotnet (linux)
0s
Test dotnet (linux)
Test grpc (linux)
0s
Test grpc (linux)
Unit test dotnet (linux)
54s
Unit test dotnet (linux)
Unit test grpc (linux)
0s
Unit test grpc (linux)
Build documentation
51s
Build documentation
Update CHANGELOG (on release)
0s
Update CHANGELOG (on release)
Check the title of the pull request
4s
Check the title of the pull request
Vulnerabilities
37s
Vulnerabilities
Check actions security
11s
Check actions security
Documentation style check
17s
Documentation style check
Testing PyAEDT main branch (Windows)
0s
Testing PyAEDT main branch (Windows)
Testing PyAEDT main branch (Linux)
0s
Testing PyAEDT main branch (Linux)
Package library
0s
Package library
Release project
0s
Release project
Upload dev documentation
0s
Upload dev documentation
Upload release documentation
0s
Upload release documentation
Fit to window
Zoom out
Zoom in

Annotations

28 errors and 12 warnings
Check actions security
Process completed with exit code 13.
Documentation style check
Vale and reviewdog exited with status code: 1
Documentation style check
reviewdog: Too many results (annotations) in diff. You may miss some annotations due to GitHub limitation for annotation created by logging command. Please check GitHub Actions log console to see all results. Limitation: - 10 warning annotations and 10 error annotations per step - 50 annotations per job (sum of annotations from all the steps) - 50 annotations per run (separate from the job annotations, these annotations aren't created by users) Source: https://github.com/orgs/community/discussions/26680#discussioncomment-3252835
Test grpc (windows)
Canceling since a higher priority waiting request for GitHub CI-refs/pull/1721/merge exists
Unit test grpc (windows)
Canceling since a higher priority waiting request for GitHub CI-refs/pull/1721/merge exists
Unit test dotnet (windows)
Canceling since a higher priority waiting request for GitHub CI-refs/pull/1721/merge exists
Test grpc (linux)
Canceling since a higher priority waiting request for GitHub CI-refs/pull/1721/merge exists
Unit test grpc (linux)
Canceling since a higher priority waiting request for GitHub CI-refs/pull/1721/merge exists
Test dotnet (linux)
Canceling since a higher priority waiting request for GitHub CI-refs/pull/1721/merge exists
Build and Smoke tests (ubuntu-latest | Python 3.12)
Canceling since a higher priority waiting request for GitHub CI-refs/pull/1721/merge exists
Build and Smoke tests (ubuntu-latest | Python 3.12)
The operation was canceled.
Build and Smoke tests (ubuntu-latest | Python 3.10)
Canceling since a higher priority waiting request for GitHub CI-refs/pull/1721/merge exists
Build and Smoke tests (ubuntu-latest | Python 3.10)
The operation was canceled.
Build and Smoke tests (ubuntu-latest | Python 3.11)
Canceling since a higher priority waiting request for GitHub CI-refs/pull/1721/merge exists
Build and Smoke tests (ubuntu-latest | Python 3.11)
The operation was canceled.
Build and Smoke tests (windows-latest | Python 3.11)
Canceling since a higher priority waiting request for GitHub CI-refs/pull/1721/merge exists
Build and Smoke tests (windows-latest | Python 3.11)
The operation was canceled.
Test dotnet (windows)
Canceling since a higher priority waiting request for GitHub CI-refs/pull/1721/merge exists
Test dotnet (windows)
The operation was canceled.
Build and Smoke tests (windows-latest | Python 3.12)
Canceling since a higher priority waiting request for GitHub CI-refs/pull/1721/merge exists
Build and Smoke tests (windows-latest | Python 3.12)
The operation was canceled.
Build and Smoke tests (windows-latest | Python 3.10)
Canceling since a higher priority waiting request for GitHub CI-refs/pull/1721/merge exists
Build and Smoke tests (windows-latest | Python 3.10)
The operation was canceled.
Build documentation
Canceling since a higher priority waiting request for GitHub CI-refs/pull/1721/merge exists
Build documentation
The operation was canceled.
Unit test dotnet (linux)
Canceling since a higher priority waiting request for GitHub CI-refs/pull/1721/merge exists
Unit test dotnet (linux)
The operation was canceled.
GitHub CI
Canceling since a higher priority waiting request for GitHub CI-refs/pull/1721/merge exists
Documentation style check: doc/source/user_guide/index.rst#L4
[vale] reported by reviewdog 🐶 [Google.Headings] 'User guide' should use sentence-style capitalization. Raw Output: {"message": "[Google.Headings] 'User guide' should use sentence-style capitalization.", "location": {"path": "doc/source/user_guide/index.rst", "range": {"start": {"line": 4, "column": 1}}}, "severity": "WARNING"}
Documentation style check: doc/source/workflows/sipi/index.rst#L1
[vale] reported by reviewdog 🐶 [Google.Headings] 'SIPI Workflows' should use sentence-style capitalization. Raw Output: {"message": "[Google.Headings] 'SIPI Workflows' should use sentence-style capitalization.", "location": {"path": "doc/source/workflows/sipi/index.rst", "range": {"start": {"line": 1, "column": 1}}}, "severity": "WARNING"}
Documentation style check: doc/source/workflows/drc/index.rst#L1
[vale] reported by reviewdog 🐶 [Google.Headings] 'DRC workflows' should use sentence-style capitalization. Raw Output: {"message": "[Google.Headings] 'DRC workflows' should use sentence-style capitalization.", "location": {"path": "doc/source/workflows/drc/index.rst", "range": {"start": {"line": 1, "column": 1}}}, "severity": "WARNING"}
Documentation style check: doc/source/workflows/drc/drc.rst#L131
[vale] reported by reviewdog 🐶 [Google.Headings] 'Export violations to CSV' should use sentence-style capitalization. Raw Output: {"message": "[Google.Headings] 'Export violations to CSV' should use sentence-style capitalization.", "location": {"path": "doc/source/workflows/drc/drc.rst", "range": {"start": {"line": 131, "column": 1}}}, "severity": "WARNING"}
Documentation style check: doc/source/workflows/drc/drc.rst#L88
[vale] reported by reviewdog 🐶 [Google.Headings] 'DRC Engine' should use sentence-style capitalization. Raw Output: {"message": "[Google.Headings] 'DRC Engine' should use sentence-style capitalization.", "location": {"path": "doc/source/workflows/drc/drc.rst", "range": {"start": {"line": 88, "column": 1}}}, "severity": "WARNING"}
Documentation style check: doc/source/workflows/drc/drc.rst#L4
[vale] reported by reviewdog 🐶 [Google.Headings] 'Design-rule checking (DRC)—self-contained, multi-threaded engine' should use sentence-style capitalization. Raw Output: {"message": "[Google.Headings] 'Design-rule checking (DRC)—self-contained, multi-threaded engine' should use sentence-style capitalization.", "location": {"path": "doc/source/workflows/drc/drc.rst", "range": {"start": {"line": 4, "column": 1}}}, "severity": "WARNING"}
Documentation style check: doc/source/workflows/utilities/siwave_log_parser.rst#L271
[vale] reported by reviewdog 🐶 [Google.Headings] 'See Also' should use sentence-style capitalization. Raw Output: {"message": "[Google.Headings] 'See Also' should use sentence-style capitalization.", "location": {"path": "doc/source/workflows/utilities/siwave_log_parser.rst", "range": {"start": {"line": 271, "column": 1}}}, "severity": "WARNING"}
Documentation style check: doc/source/workflows/utilities/siwave_log_parser.rst#L123
[vale] reported by reviewdog 🐶 [Google.Will] Avoid using 'will'. Raw Output: {"message": "[Google.Will] Avoid using 'will'.", "location": {"path": "doc/source/workflows/utilities/siwave_log_parser.rst", "range": {"start": {"line": 123, "column": 68}}}, "severity": "WARNING"}
Documentation style check: doc/source/workflows/utilities/siwave_log_parser.rst#L28
[vale] reported by reviewdog 🐶 [Google.Headings] 'Quick Start' should use sentence-style capitalization. Raw Output: {"message": "[Google.Headings] 'Quick Start' should use sentence-style capitalization.", "location": {"path": "doc/source/workflows/utilities/siwave_log_parser.rst", "range": {"start": {"line": 28, "column": 1}}}, "severity": "WARNING"}
Documentation style check: doc/source/workflows/utilities/index.rst#L1
[vale] reported by reviewdog 🐶 [Google.Headings] 'Utilities Workflows' should use sentence-style capitalization. Raw Output: {"message": "[Google.Headings] 'Utilities Workflows' should use sentence-style capitalization.", "location": {"path": "doc/source/workflows/utilities/index.rst", "range": {"start": {"line": 1, "column": 1}}}, "severity": "WARNING"}
Test dotnet (windows)
No files were found with the provided path: .cov\system-html. No artifacts will be uploaded.
Unit test dotnet (linux)
No files were found with the provided path: .cov/unit-html. No artifacts will be uploaded.

Artifacts

Produced during runtime
Name Size Digest
pyedb-v0.66.dev0-wheelhouse-ubuntu-latest-3.10-sbom Expired
70.5 KB
sha256:79f81a4cbf4207d375a3369b0a7c83605f5a96c997096c409889fc8376dee13a
pyedb-v0.66.dev0-wheelhouse-ubuntu-latest-3.11-sbom Expired
69.7 KB
sha256:a809990091077ea3d4aecf143f5c5d2094cebfc87a68d081007498cb90e9fe47
pyedb-v0.66.dev0-wheelhouse-ubuntu-latest-3.12-sbom Expired
69.7 KB
sha256:c8f8199ea1da38124c66f5314cf7ecfe32e87a9d6b833085f31cf8b0e6b3cc85
pyedb-v0.66.dev0-wheelhouse-windows-latest-3.10-sbom Expired
27 KB
sha256:700705c486f87f8f3497e899fe774b7fd31d12b1ed962fbe5df40a78cb64196f