Use Sybil to put code samples in Sphinx under some kind of testing.

mmerickel / wired

A service locator implementation for Python.

https://wired.readthedocs.io

MIT License

17 stars 9 forks source link

Use Sybil to put code samples in Sphinx under some kind of testing. #17

Closed pauleveritt closed 5 years ago

pauleveritt commented 5 years ago

Docs are part reference, part storytelling. The storytelling can work nicely with code, as stuff like Reg and Dectate show. This PR uses Chris Withers' Sybil to make samples in Sphinx docs into pytest test cases. Only used on the home page index.rst at the moment. Not integrated into Travis yet.

pauleveritt commented 5 years ago

I'm enjoying the use of Sybil so far. At the same time, it's something I could do locally without committing you to its use. Let me know if you'd prefer I go in that direction.

mmerickel commented 5 years ago

I don't mind adding it if you think it's working well.

pauleveritt commented 5 years ago

(Putting this comment on the correct PR.) I'm going to merge this. Sybil worked well in the one spot I used it (for now) and Chris was responsive to questions, adding a skip feature I needed.