Skip to content

Test examples & configuration from documentation #1320

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

Open
bhirsz opened this issue Mar 14, 2025 · 0 comments
Open

Test examples & configuration from documentation #1320

bhirsz opened this issue Mar 14, 2025 · 0 comments
Labels
documentation Improvements or additions to documentation testing All testing related issues

Comments

@bhirsz
Copy link
Member

bhirsz commented Mar 14, 2025

We have several code examples in our documentation - either in rst files or doc strings. It's usually command line options or configuration file content.

Unfortunately we had several episodes in the past where we had invalid configuration in our documentation, especially when migration/deprecating something. We need solution to gather such examples and test them.

We will need special markers for it, so the parser will understand if given code example is configuration to be tested or something else which can be ignored. Or at least recognize every line in code blocks that starts with robocop or [tool.robocop.

@bhirsz bhirsz added documentation Improvements or additions to documentation testing All testing related issues labels Mar 14, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation testing All testing related issues
Projects
None yet
Development

No branches or pull requests

1 participant