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.

Sign up for GitHub

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

Jump to bottom

Move documentation of the various built-ins to the source code #2427

Closed
vkarak opened this issue Feb 15, 2022 · 0 comments · Fixed by #2470
Closed

Move documentation of the various built-ins to the source code #2427

vkarak opened this issue Feb 15, 2022 · 0 comments · Fixed by #2470
Assignees
@vkarak
Labels
code quality documentation
Milestone
ReFrame sprint 22...

Comments

@vkarak
Copy link
Contributor

vkarak commented Feb 15, 2022

Currently, this is mostly separated and the bulk of the documentation of the API is in the regression_test_api.rst file, but we could use the autofunction etc. functionality of Sphinx to make it pull the documentation from the source code.
@vkarak vkarak changed the title Move documentation of the various built-ins in the source code Move documentation of the various built-ins to the source code Feb 15, 2022
@vkarak vkarak added this to the ReFrame sprint 22.03.1 milestone Mar 9, 2022
@vkarak vkarak self-assigned this Mar 12, 2022
@vkarak vkarak mentioned this issue Mar 12, 2022
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@vkarak vkarak

Labels
code quality documentation
Projects
None yet
Milestone
ReFrame sprint 22.03.1
Development

Successfully merging a pull request may close this issue.

[refactor] Move builtins in a separate module file and improve make_test() vkarak/reframe
1 participant
@vkarak