Merge b30c575 into 062d70d

.travis.yml

@@ -38,6 +38,7 @@ install:
 script:
 - |
   if [[ "$TEST_TYPE" == "pytest" ]]; then
+      # pytest -v --nb-test-files --log-cli-level=info --cov=pytest_notebook --cov-report=
       pytest -v --cov=pytest_notebook --cov-report=
   fi
 - |

MANIFEST.in

@@ -6,3 +6,4 @@ recursive-exclude * __pycache__
 recursive-exclude * *.py[co]
 
 recursive-include pytest_notebook/example_nbs *.ipynb
+recursive-include pytest_notebook/resources *.json

docs/source/apidoc/pytest_notebook.rst

@@ -7,6 +7,7 @@ Subpackages
 .. toctree::
 
    pytest_notebook.example_nbs
+   pytest_notebook.resources
 
 Submodules
 ----------
@@ -17,6 +18,7 @@ Submodules
    pytest_notebook.execution
    pytest_notebook.ipy_magic
    pytest_notebook.nb_regression
+   pytest_notebook.notebook
    pytest_notebook.plugin
    pytest_notebook.post_processors
    pytest_notebook.utils

docs/source/conf.py

@@ -77,6 +77,7 @@
     ("py:class", "attr.s"),
     ("py:class", "ruamel.yaml.dumper.RoundTripDumper"),
     ("py:exc", "nbconvert.preprocessors.CellExecutionError"),
+    ("py:class", "nbconvert.preprocessors.execute.ExecutePreprocessor"),
 ]
 
 # The reST default role (used for this markup: `text`) to use for all

docs/source/index.rst

@@ -14,6 +14,14 @@ pytest-notebook
    :hidden:
 
    user_guide/tutorial_intro
+   user_guide/tutorial_config
+
+.. toctree::
+   :maxdepth: 1
+   :caption: Validation Schemas
+   :hidden:
+
+   literal_includes/nb_metadata_schema
 
 .. toctree::
    :maxdepth: 1
@@ -56,15 +64,15 @@ Features
    2. As a pytest fixtures.
    3. Using the ``pytest_notebook`` python package.
 
--  All stages are highly configurable *via*:
+-  All stages are highly configurable (see :ref:`configuring_pytest_notebook`) *via*:
 
    1. The pytest command-line interface.
    2. The pytest configuration file.
    3. The notebook and cell level metadata.
 
 -  Post-processor plugin entry-points, allow for customisable
    modifications of the notebook, including source code formatting with
-   `black`_
+   `black`_ (see :ref:`post_processors`).
 
 .. image:: _static/collaged_in_out.png
    :alt: Configuration Examples

docs/source/literal_includes/nb_metadata_schema.rst

@@ -0,0 +1,20 @@
+.. _nb_metadata_schema:
+
+Notebook/Cell Metadata Schema
+-----------------------------
+
+This schema is applied to keys under the ``nbreg`` key.
+
+For example:
+
+.. code:: json
+
+   {
+      "nbreg": {
+        "skip": true,
+        "skip_reason": "There is an unresolved exception"
+      }
+   }
+
+.. literalinclude:: ../../../pytest_notebook/resources/nb_metadata.schema.json
+  :language: JSON