-
Notifications
You must be signed in to change notification settings - Fork 18
Description
I think it'd be easier to test the behavior of directives and if there were sample built pages to look out. As a model, matplotlib and sphinx gallery both build minimal documents to test their directives:
- https://github.com/matplotlib/matplotlib/tree/main/lib/matplotlib/tests/tinypages
- https://github.com/sphinx-gallery/sphinx-gallery/tree/master/sphinx_gallery/tests/tinybuild
TL;DR is that tinybuild is designed as a minimal full sphinx doc build that you can run with
make htmlfrom the tinybuild/doc to get a traditional build experience, but also gets run in test_full.py so you can check for html or rst output. So basically you can think of stuff in test_full.py as pytests that have access to a full site built with sphinx-build.One gotcha at the moment is that you might need to run
make cleanin tinybuild/doc for the pytest version to run properlyOriginally posted by @larsoner in sphinx-gallery/sphinx-gallery#1222 (comment)
This isn't too different from the current sample output but I think more robust.