CI

Chore/doc linting #38

Sign in to view logs

Triggered via pull request January 2, 2024 19:09

tmpbeing

synchronize #13

chore/doc-linting

Status Success

Total duration 6m 27s

Artifacts 11

ci_cd.yml

on: pull_request

Documentation style

Build documentation

Matrix: Build and Smoke tests

Matrix: tests

Build library basic example

Deploy development documentation

Deploy stable documentation

Release to private and public PyPI and to GitHub

Annotations

38 warnings

[vale] doc/source/api_reference/training_data_parts.rst#L3: doc/source/api_reference/training_data_parts.rst#L3

[Google.Headings] 'Training Data Part' should use sentence-style capitalization.

[vale] doc/source/api_reference/training_data.rst#L3: doc/source/api_reference/training_data.rst#L3

[Google.Headings] 'Training Data' should use sentence-style capitalization.

[vale] doc/source/api_reference/design_of_experiments.rst#L3: doc/source/api_reference/design_of_experiments.rst#L3

[Google.Headings] 'Design of Experiments' should use sentence-style capitalization.

[vale] doc/source/api_reference/data_types.rst#L1: doc/source/api_reference/data_types.rst#L1

[Google.Headings] 'Data Types' should use sentence-style capitalization.

[vale] doc/source/api_reference/workspaces.rst#L8: doc/source/api_reference/workspaces.rst#L8

[Google.OxfordComma] Use the Oxford comma in 'Workspaces are a set of specific geometries, predictions and'.

[vale] doc/source/api_reference/workspaces.rst#L27: doc/source/api_reference/workspaces.rst#L27

[Google.Headings] 'ModelManifest' should use sentence-style capitalization.

[vale] doc/source/api_reference/geometries.rst#L19: doc/source/api_reference/geometries.rst#L19

[Google.We] Try to avoid using first-person plural like 'us'.

[vale] doc/source/api_reference/post_processings.rst#L3: doc/source/api_reference/post_processings.rst#L3

[Google.Headings] 'Post-Processings' should use sentence-style capitalization.

[vale] doc/source/api_reference/post_processings.rst#L23: doc/source/api_reference/post_processings.rst#L23

[Google.Headings] 'Nested Prediction Namespace' should use sentence-style capitalization.

[vale] doc/source/api_reference/post_processings.rst#L35: doc/source/api_reference/post_processings.rst#L35

[Google.WordList] Use 'select' instead of 'check'.

[vale] doc/source/api_reference.rst#L3: doc/source/api_reference.rst#L3

[Google.Headings] 'API Reference' should use sentence-style capitalization.

[vale] doc/source/user_guide/best_practices.rst#L3: doc/source/user_guide/best_practices.rst#L3

[Google.Headings] 'Best Practices' should use sentence-style capitalization.

[vale] doc/source/user_guide/best_practices.rst#L10: doc/source/user_guide/best_practices.rst#L10

[Google.Will] Avoid using 'will'.

[vale] doc/source/user_guide/best_practices.rst#L41: doc/source/user_guide/best_practices.rst#L41

[Google.Will] Avoid using 'will'.

[vale] doc/source/user_guide/best_practices.rst#L69: doc/source/user_guide/best_practices.rst#L69

[Google.Will] Avoid using 'will'.

[vale] doc/source/user_guide/training.rst#L22: doc/source/user_guide/training.rst#L22

[Google.Will] Avoid using 'will'.

[vale] doc/source/user_guide/proxy.rst#L6: doc/source/user_guide/proxy.rst#L6

[Google.Will] Avoid using 'will'.

[vale] doc/source/user_guide/proxy.rst#L8: doc/source/user_guide/proxy.rst#L8

[Google.Headings] 'SDK configuration' should use sentence-style capitalization.

[vale] doc/source/user_guide/proxy.rst#L21: doc/source/user_guide/proxy.rst#L21

[Google.Will] Avoid using 'will'.

[vale] doc/source/user_guide/config_file.rst#L3: doc/source/user_guide/config_file.rst#L3

[Google.Headings] 'Configuration File' should use sentence-style capitalization.

[vale] doc/source/user_guide/config_file.rst#L16: doc/source/user_guide/config_file.rst#L16

[Google.Will] Avoid using 'will'.

[vale] doc/source/user_guide/config_file.rst#L32: doc/source/user_guide/config_file.rst#L32

[Google.Will] Avoid using 'will'.

[vale] doc/source/user_guide/config_file.rst#L75: doc/source/user_guide/config_file.rst#L75

[Google.Will] Avoid using 'will'.

[vale] doc/source/user_guide/data_exploration.rst#L3: doc/source/user_guide/data_exploration.rst#L3

[Google.Headings] 'Data Exploration' should use sentence-style capitalization.

[vale] doc/source/user_guide/data_exploration.rst#L45: doc/source/user_guide/data_exploration.rst#L45

[Google.Colons] ': T' should be in lowercase.

[vale] doc/source/user_guide/configuration.rst#L4: doc/source/user_guide/configuration.rst#L4

[Google.Headings] 'Client Configuration' should use sentence-style capitalization.

[vale] doc/source/user_guide/configuration.rst#L10: doc/source/user_guide/configuration.rst#L10

[Google.Will] Avoid using 'will'.

[vale] doc/source/user_guide/configuration.rst#L22: doc/source/user_guide/configuration.rst#L22

[Google.We] Try to avoid using first-person plural like 'we'.

[vale] doc/source/api_reference/optimizations.rst#L21: doc/source/api_reference/optimizations.rst#L21

[Google.Headings] 'TrialRun' should use sentence-style capitalization.

[vale] doc/source/index.rst#L10: doc/source/index.rst#L10

[Google.Headings] 'PySimAI documentation' should use sentence-style capitalization.

[vale] doc/source/index.rst#L18: doc/source/index.rst#L18

[Google.Headings] 'What is PySimAI ?' should use sentence-style capitalization.

[vale] doc/source/index.rst#L21: doc/source/index.rst#L21

[Google.We] Try to avoid using first-person plural like 'let's'.

[vale] doc/source/index.rst#L28: doc/source/index.rst#L28

[Google.Headings] 'SDK Installation' should use sentence-style capitalization.

[vale] doc/source/index.rst#L50: doc/source/index.rst#L50

[Google.Will] Avoid using 'will'.

[vale] doc/source/api_reference/selections.rst#L6: doc/source/api_reference/selections.rst#L6

[Google.Headings] 'Selections Basics' should use sentence-style capitalization.

[vale] doc/source/api_reference/selections.rst#L44: doc/source/api_reference/selections.rst#L44

[Google.Headings] 'Selections API Reference' should use sentence-style capitalization.

[vale] doc/source/api_reference/selections.rst#L59: doc/source/api_reference/selections.rst#L59

[Google.Headings] 'Post-processing Basics' should use sentence-style capitalization.

[vale] doc/source/api_reference/selections.rst#L112: doc/source/api_reference/selections.rst#L112

[Google.Headings] 'Post-processing API Reference' should use sentence-style capitalization.

Artifacts

Produced during runtime

Name	Size
ansys-simai-core-artifacts Expired	151 KB
ansys-simai-core-v0.0.1-wheelhouse-ubuntu-latest-3.10 Expired	3.16 MB
ansys-simai-core-v0.0.1-wheelhouse-ubuntu-latest-3.11 Expired	3.16 MB
ansys-simai-core-v0.0.1-wheelhouse-ubuntu-latest-3.12 Expired	3.15 MB
ansys-simai-core-v0.0.1-wheelhouse-ubuntu-latest-3.9 Expired	3.16 MB
ansys-simai-core-v0.0.1-wheelhouse-windows-latest-3.10 Expired	2.94 MB
ansys-simai-core-v0.0.1-wheelhouse-windows-latest-3.11 Expired	2.94 MB
ansys-simai-core-v0.0.1-wheelhouse-windows-latest-3.12 Expired	2.91 MB
ansys-simai-core-v0.0.1-wheelhouse-windows-latest-3.9 Expired	2.94 MB
documentation-html Expired	2.41 MB
documentation-pdf Expired	400 KB