]> git.ipfire.org Git - thirdparty/krb5.git/commit
Fix doc issues with newer Doxygen and Sphinx 1119/head
authorGreg Hudson <ghudson@mit.edu>
Tue, 22 Sep 2020 15:32:00 +0000 (11:32 -0400)
committerGreg Hudson <ghudson@mit.edu>
Tue, 29 Sep 2020 01:01:57 +0000 (21:01 -0400)
commit281210909beef4683be3b63bc1ac1e75c2c9c7eb
treeab8193536b0d9e3ce583341809aa3c582637d8f6
parent521175fd41f09d97d15d4d5a40b6611b81ef375f
Fix doc issues with newer Doxygen and Sphinx

In krb5.hin, fix some apparently harmless whitespace nits in comments
which cause newer Doxygen versions to generate <detaileddescription>
content containing <linebreak/> tags.  Also remove the explicit "@n"
linebreaks in the responder JSON schemas, instead relying on Doxygen
markup support (added in Doxygen 1.8).  Add a verbatim handler in
doxybuilder_types.py to translate the resulting section, replacing the
linebreak handler which is no longer needed.

css_files is deprecated in Sphinx.  Instead use app.add_stylesheet()
in a setup function in conf.py.  (Sphinx 1.8 has a slightly simpler
method, but that is currently too recent to depend on.)  Also remove
the obsolete html_use_smartypants setting.

In func_document.tmpl, fix an incorrent use of "is".

ticket: 8952 (new)
doc/_templates/layout.html
doc/conf.py
doc/tools/doxybuilder_types.py
doc/tools/func_document.tmpl
src/include/krb5/krb5.hin