diff options
| author | Jay Berkenbilt <ejb@ql.org> | 2021-12-21 15:23:20 +0100 |
|---|---|---|
| committer | Jay Berkenbilt <ejb@ql.org> | 2021-12-21 15:52:41 +0100 |
| commit | 36916619f0b07b4412df5a96683579552dd96285 (patch) | |
| tree | 29df82de9a033570826c2791f9b6457ac7b63bd5 /manual/release-notes.rst | |
| parent | e058247bcfb132866dae5c873db7591bcc13db7e (diff) | |
| download | qpdf-36916619f0b07b4412df5a96683579552dd96285.tar.zst | |
Stop adding pre-built documentation to the source distribution
Diffstat (limited to 'manual/release-notes.rst')
| -rw-r--r-- | manual/release-notes.rst | 24 |
1 files changed, 10 insertions, 14 deletions
diff --git a/manual/release-notes.rst b/manual/release-notes.rst index 7db44c08..15089f40 100644 --- a/manual/release-notes.rst +++ b/manual/release-notes.rst @@ -6,29 +6,25 @@ Release Notes For a detailed list of changes, please see the file :file:`ChangeLog` in the source distribution. -10.5.0: December 20, 2021 +10.5.0: December 21, 2021 - 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. + - Pre-built documentation is no longer distributed with the source + distribution. The AppImage and Windows binary distributions + still contain embedded documentation, and a separate ``doc`` + distribution file is available from the qpdf release site. + Documentation is now available at `https://qpdf.readthedocs.io + <https://qpdf.readthedocs.io>`__ for every major/minor version + starting with version 10.5. Please see :ref:`packaging-doc` for + details on how packagers should handle documentation. - The documentation sources have been switched from docbook to reStructuredText processed with `Sphinx - <https://sphinx-doc.org>`__. This will break previous + <https://www.sphinx-doc.org>`__. 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. - - Documentation is now available at `https://qpdf.readthedocs.io - <https://qpdf.readthedocs.io>`__. - - Library Enhancements - Since qpdf version 8, using object accessor methods on an |