TST/DOC: set up doctesting - #921
Conversation
|
cc @lucascolley |
lucascolley
added
DX
testing
documentation
|
aha, thanks for working on this! There are some merge conflicts now, sorry, bad timing with a big refactor. Let me know if you have any trouble resolving them. |
484ca6e to
7ad199d
Compare
@lucascolley I think the conflicts are fixed now. |
lucascolley
left a comment
lucascolley
left a comment
There was a problem hiding this comment.
thanks Florian, this is awesome!
| environments: tests | ||
|
|
||
| - name: Test public API examples | ||
| run: pixi run -e tests doctests |
There was a problem hiding this comment.
unnecessary thanks to default-environment
| run: pixi run -e tests doctests | |
| run: pixi run doctests |
| ```bash | ||
| pixi run tests # run the tests | ||
| pixi run open-docs # build and preview the docs | ||
| pixi run doctests # run the doctests in the docs |
There was a problem hiding this comment.
| pixi run doctests # run the doctests in the docs | |
| pixi run doctests # test docs examples |
There was a problem hiding this comment.
@ev-br please could you confirm that this file looks good?
There was a problem hiding this comment.
Yes, scipy-doctest configuration in conftests.py looks good!
| @@ -0,0 +1,28 @@ | |||
| """Configure public API doctests.""" | |||
There was a problem hiding this comment.
That's all the file is doing now, but it isn't the purpose of the file in general.
| """Configure public API doctests.""" | |
| """Configure pytest.""" |
3 participants
Closes #397
This PR tries to set up doctesting using scipy_doctest. I had to fixed a couple of doc examples for
pixi run docteststo pass.I worked with Codex on this, notably the
conftest.py.