From 426b4ce8565e4f9143c122fd3afbcc22598fc6c4 Mon Sep 17 00:00:00 2001 From: Jay Berkenbilt Date: Sat, 18 Dec 2021 11:19:20 -0500 Subject: Update documentation build/installation --- manual/release-notes.rst | 29 +++++++++++++++++++---------- 1 file changed, 19 insertions(+), 10 deletions(-) (limited to 'manual/release-notes.rst') diff --git a/manual/release-notes.rst b/manual/release-notes.rst index 5a8fd307..adb2a48d 100644 --- a/manual/release-notes.rst +++ b/manual/release-notes.rst @@ -7,6 +7,25 @@ For a detailed list of changes, please see the file :file:`ChangeLog` in the source distribution. 10.5.0: XXX Month dd, YYYY + - Packaging changes + + - The structure of the ``doc`` directory is different. The PDF + documentation is in the same place, but the files for the + previous HTML documentation are no longer there. Instead, there + are ``html`` and ``singlehtml`` directories, each of which + contain ``index.html`` and other files and directories. The + distribution files and ``make install`` target handle this, but + if you are building your own packages and including + documentation, please double check to make sure that you are + including the right documentation files. + + - The documentation sources have been switched from docbook to + reStructuredText processed with `Sphinx + `__. This will break previous + documentation links. A redirect is in place on the main website. + A top-to-bottom review of the documentation is planned for an + upcoming release. + - Library Enhancements - Since qpdf version 8, using object accessor methods on an @@ -58,16 +77,6 @@ For a detailed list of changes, please see the file - Add ``qpdf_oh_get_type_code`` and ``qpdf_oh_get_type_name``. - - Documentation change - - - The documentation sources have been switched from docbook to - reStructuredText processed with `Sphinx - `__. 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 -- cgit v1.2.3-54-g00ecf