sphinxcontrib-jupyter icon indicating copy to clipboard operation
sphinxcontrib-jupyter copied to clipboard

Add test capability for configuration options

Open mmcky opened this issue 5 years ago • 3 comments

PR #72 will introduce the ability to compile a set of notebooks with and without a set of solutions.

However testing the configuration side is currently difficult as sphinx needs to be run based on a matrix of configuration settings. It would be nice however to have a test case for with and without solutions (i.e. two notebooks in ipynb references)

mmcky avatar Aug 21 '18 06:08 mmcky

See Issue #57

mmcky avatar Aug 21 '18 06:08 mmcky

  • [ ] figure out how to test this with and without solutions (PR #72) - through adjustments to conf.py.

Can we introduce a context manager? We will also need to know what to compare so may need to introduce a configuration matrix such that:

jupyter_drop_solutions = True  :  solutions_2.ipynb

otherwise we can generate conf.py from a template and use yaml for specifying a CI configuration set of tests:

A:
   sphinxcontrib-jupyter:
        options : { jupyter_drop_solutions = True }
        ipynb : {solutions_2.ipynb }

mmcky avatar Aug 29 '18 05:08 mmcky

@jlperla just moved your comments to an individual issue. Thanks for the writeup.

mmcky avatar Aug 29 '18 05:08 mmcky