Test code examples in docs #387
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
greschd
force-pushed
the
maint/add_doctest
branch
3 times, most recently
from
d5104ca to
7f134e3
Compare
greschd
force-pushed
the
maint/add_doctest
branch
from
7f134e3 to
733bde9
Compare
greschd
commented
Feb 5, 2024
| @@ -201,6 +201,86 @@ jobs: | |||
| github-token: ${{ secrets.GITHUB_TOKEN }} | |||
| if: matrix.python-version == '3.9' && github.ref == 'refs/heads/main' | |||
|
|
|||
| doctest: | |||
There was a problem hiding this comment.
Could also be done as part of one of the other jobs, but since the purpose is somewhat different from both doc and test jobs, I decided to create a separate job.
greschd
commented
Feb 5, 2024
| @@ -37,16 +37,36 @@ Load a model | |||
|
|
|||
| To load a model in ACP, use the :meth:`import_model <.ACP.import_model>` method: | |||
|
|
|||
| .. code-block:: python | |||
| .. testcode:: | |||
| :hide: | |||
There was a problem hiding this comment.
Upload of the file to the server is hidden; the tempfile is used just to rename the file.
janvonrickenbach
approved these changes
Feb 6, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Add the
sphinx.ext.doctestplugin to the documentation, and run thedoctestcheck in a separate CI job to ensure the code examples inthe docs are working.
Closes #384