Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add CI workflow for testing documentation examples #1629

Merged
merged 25 commits into from
Feb 11, 2025

Conversation

kboyarinov
Copy link
Contributor

@kboyarinov kboyarinov commented Feb 5, 2025

Description

Add testing of code snippets from reference and user guide:

  • Introduce CMake for examples testing
  • Extract examples from rfc to external .cpp files
  • Add CI workflow for testing on Linux

Userguide examples were not completely moved to .cpp from .rst yet
Testing on Windows was not enabled yet

Fixes # - issue number(s) if exists

Type of change

Choose one or multiple, leave empty if none of the other choices apply

Add a respective label(s) to PR if you have permissions

  • bug fix - change that fixes an issue
  • new feature - change that adds functionality
  • tests - change in tests
  • infrastructure - change in infrastructure and CI
  • documentation - documentation update

Tests

  • added - required for new features and some bug fixes
  • not needed

Documentation

  • updated in # - add PR number
  • needs to be updated
  • not needed

Breaks backward compatibility

  • Yes
  • No
  • Unknown

Notify the following users

List users with @ to send notifications

Other information

@kboyarinov kboyarinov marked this pull request as draft February 5, 2025 11:18
@kboyarinov kboyarinov marked this pull request as ready for review February 5, 2025 12:06
Copy link
Contributor

@aleksei-fedotov aleksei-fedotov left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Finally, we are going to have this step automated! Hooray!

.github/workflows/ci.yml Outdated Show resolved Hide resolved
doc/main/examples_testing/CMakeLists.txt Outdated Show resolved Hide resolved
doc/main/examples_testing/CMakeLists.txt Outdated Show resolved Hide resolved
.github/workflows/ci.yml Outdated Show resolved Hide resolved
doc/main/examples_testing/CMakeLists.txt Show resolved Hide resolved
CMakeLists.txt Show resolved Hide resolved
doc/main/examples_testing/CMakeLists.txt Outdated Show resolved Hide resolved
doc/main/examples_testing/CMakeLists.txt Outdated Show resolved Hide resolved
isaevil
isaevil previously approved these changes Feb 11, 2025
Copy link
Contributor

@isaevil isaevil left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Github Actions and CMake side looks good to me.

@kboyarinov kboyarinov merged commit 45c2298 into master Feb 11, 2025
29 checks passed
@kboyarinov kboyarinov deleted the dev/kboyarinov/testing-doc-examples branch February 11, 2025 14:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants