chiark / gitweb /
documentation: verify HTML escaping for both the doxygen and python theme.
authorVladimír Vondruš <mosra@centrum.cz>
Tue, 17 Sep 2024 21:00:52 +0000 (23:00 +0200)
committerVladimír Vondruš <mosra@centrum.cz>
Wed, 25 Sep 2024 19:30:33 +0000 (21:30 +0200)
commitd6f0ca1af2b36da33a0998d1095a13a5b6c99b1c
treeb04fb9c6a3b0c4f86322feee397c98210ef8802c
parent083c7a87dcca80027a4bc9c5e6db3bab4babffb0
documentation: verify HTML escaping for both the doxygen and python theme.

It's a mess and needs to be cleaned up, especially given that I now need
to have non-HTML output from the Python generator, so it's good to have
it actually regression checked.

This actually revealed one superfluous unescape in the Python theme
(which was likely a leftover from when that code was copypasted from the
Doxygen theme), and a Doxygen bug where it doesn't unescape image alt
text. Then m.css doesn't correctly escape the alt text either, which
makes the bug cancel out and everything is alright.

Oh and there's also a bug where if special HTML chars are used in
filenames, it breaks the Doxygen XML output. I should probably make a PR
for those two.
28 files changed:
documentation/doxygen.py
documentation/python.py
documentation/test_doxygen/__init__.py
documentation/test_doxygen/contents_html_escape/Doxyfile [new file with mode: 0644]
documentation/test_doxygen/contents_html_escape/Fi&le.h [new file with mode: 0644]
documentation/test_doxygen/contents_html_escape/Fi_6le_8h.html [new file with mode: 0644]
documentation/test_doxygen/contents_html_escape/annotated.html [new file with mode: 0644]
documentation/test_doxygen/contents_html_escape/files.html [new file with mode: 0644]
documentation/test_doxygen/contents_html_escape/page-1820.html [new file with mode: 0644]
documentation/test_doxygen/contents_html_escape/page.dox [new file with mode: 0644]
documentation/test_doxygen/contents_html_escape/page.html [new file with mode: 0644]
documentation/test_doxygen/contents_html_escape/pages.html [new file with mode: 0644]
documentation/test_doxygen/contents_html_escape/structClass.html [new file with mode: 0644]
documentation/test_doxygen/contents_html_escape/structSub_3_01char_00_01T_01_4.html [new file with mode: 0644]
documentation/test_doxygen/contents_html_escape/structSub_3_01char_00_01T_01_4_1_1Nested.html [new file with mode: 0644]
documentation/test_doxygen/contents_html_escape/tiny.png [new symlink]
documentation/test_doxygen/contents_typography/indexpage_1817.xml [new file with mode: 0644]
documentation/test_doxygen/test_contents.py
documentation/test_python/CMakeLists.txt
documentation/test_python/content_html_escape/content_html_escape.Class.html [new file with mode: 0644]
documentation/test_python/content_html_escape/content_html_escape.html [new file with mode: 0644]
documentation/test_python/content_html_escape/content_html_escape.pybind.html [new file with mode: 0644]
documentation/test_python/content_html_escape/content_html_escape/__init__.py [new file with mode: 0644]
documentation/test_python/content_html_escape/content_html_escape/pybind.cpp [new file with mode: 0644]
documentation/test_python/content_html_escape/page.html [new file with mode: 0644]
documentation/test_python/content_html_escape/page.rst [new file with mode: 0644]
documentation/test_python/content_html_escape/pages.html [new file with mode: 0644]
documentation/test_python/test_content.py