test_doc.py 972 B

12345678910111213141516171819202122232425262728293031323334
  1. import pytest
  2. def test_sphinx_gallery_example_header():
  3. """
  4. We have copied EXAMPLE_HEADER and modified it to include meta keywords.
  5. This test monitors that the version we have copied is still the same as
  6. the EXAMPLE_HEADER in sphinx-gallery. If sphinx-gallery changes its
  7. EXAMPLE_HEADER, this test will start to fail. In that case, please update
  8. the monkey-patching of EXAMPLE_HEADER in conf.py.
  9. """
  10. gen_rst = pytest.importorskip('sphinx_gallery.gen_rst')
  11. EXAMPLE_HEADER = """
  12. .. DO NOT EDIT.
  13. .. THIS FILE WAS AUTOMATICALLY GENERATED BY SPHINX-GALLERY.
  14. .. TO MAKE CHANGES, EDIT THE SOURCE PYTHON FILE:
  15. .. "{0}"
  16. .. LINE NUMBERS ARE GIVEN BELOW.
  17. .. only:: html
  18. .. note::
  19. :class: sphx-glr-download-link-note
  20. :ref:`Go to the end <sphx_glr_download_{1}>`
  21. to download the full example code{2}
  22. .. rst-class:: sphx-glr-example-title
  23. .. _sphx_glr_{1}:
  24. """
  25. assert gen_rst.EXAMPLE_HEADER == EXAMPLE_HEADER