added minimal pytest with example rst file

[shimwell]

Thanks for making this super useful package

I have checked the other PR #20 using this minimal pytest code.

Perhaps this could be a start for testing

Here you can see the tests fail on the current master branch and pass on the branch with the fix for sphinx v4

[Peque]

Good initiative! :blush:

A couple of comments:

• Can you put everything under tests/? In example, you could create a tests/example/conf.py file.
• Since you use pytest (I prefer that too :blush:), can you remove the unittest import and the class definition in the test?

Also, it is nice to have tests to run locally, but it is even better to have them running in CI! (i.e.: with Travis or GitHub Actions). I have another repo that you may check if you feel brave enough to go that extra mile. :stuck_out_tongue:

https://github.com/markdownreveal/markdownreveal

(check out the tox.ini file and .travis.yml file if you feel interested)

[shimwell]

Yep I can give that a go.

Might even get a git squash out of me at the end :stuck_out_tongue_winking_eye:

I believe GitHub Actions don't trigger from forks but I can get it most of the way there.

[shimwell]

Appears to be working over on my fork (where the GH actions run) https://github.com/Shimwell/sphinxcadquery/actions/runs/829495457

[shimwell]

Wondering if you have the "Squash and merge" option on this on a pull request

https://i.stack.imgur.com/8t1OJ.png

[Peque]

@Shimwell Yes, I do have the option to squash the commits myself when merging PRs.

When I do that, I become the committer, while you keep the authorship of the commit. I don't mind much, but I would rather leave your name as the committer too, if you are willing to do the clean-up-before-merge yourself. :stuck_out_tongue_winking_eye:

[shimwell]

Yep I can make these changes, thanks for the suggestions

[Peque]

Closing in favor of https://github.com/Peque/sphinxcadquery/pull/27.