ChangeLog/release note on doc change

This commit is contained in:
Jay Berkenbilt 2021-12-12 17:57:11 -05:00
parent 61f52cb6ac
commit 43740ea733
2 changed files with 15 additions and 1 deletions

View File

@ -1,3 +1,7 @@
2021-12-12 Jay Berkenbilt <ejb@ql.org>
* Convert documentation from docbook to reStructuredText/Sphinx.
2021-12-10 Jay Berkenbilt <ejb@ql.org>
* Handle bitstream overflow errors more gracefully. Fixes #581.

View File

@ -117,7 +117,7 @@ ghostscript.
Pre-built documentation is distributed with qpdf, so you should
generally not need to rebuild the documentation. In order to build the
documentation from source, you need to install `sphinx
documentation from source, you need to install `Sphinx
<https://sphinx-doc.org>`__. To build the PDF version of the
documentation, you need `pdflatex`, `latexmk`, and a fairly complete
LaTeX installation. Detailed requirements can be found in the Sphinx
@ -3650,6 +3650,16 @@ For a detailed list of changes, please see the file
and ``qpdf_replace_object``, exposing the corresponding methods
in ``QPDF`` and ``QPDFObjectHandle``.
- Documentation change
- The documentation sources have been switched from docbook to
reStructuredText processed with `Sphinx
<https://sphinx-doc.org>`__. This is mostly transparent (other
than format change) with the exception that all section links
have changed. What used to be `#ref.something` is now
`#something`. A top-to-bottom review of the documentation is
planned for an upcoming release.
10.4.0: November 16, 2021
- Handling of Weak Cryptography Algorithms