OpenSystemsDevelopment / qpdf

Commit 43740ea7336c88402c7b232a9bf783a798b32c94

Authored by Jay Berkenbilt
1 parent 61f52cb6

ChangeLog/release note on doc change

Inline Side-by-side
Showing 2 changed files with 15 additions and 1 deletions
ChangeLog
  View file @43740ea
  1 +2021-12-12 Jay Berkenbilt <ejb@ql.org>
  2 +
  3 + * Convert documentation from docbook to reStructuredText/Sphinx.
  4 +
1 5 2021-12-10 Jay Berkenbilt <ejb@ql.org>
2 6  
3 7 * Handle bitstream overflow errors more gracefully. Fixes #581.
... ...
manual/index.rst
  View file @43740ea
... ... @@ -117,7 +117,7 @@ ghostscript.
117 117  
118 118 Pre-built documentation is distributed with qpdf, so you should
119 119 generally not need to rebuild the documentation. In order to build the
120   -documentation from source, you need to install `sphinx
  120 +documentation from source, you need to install `Sphinx
121 121 <https://sphinx-doc.org>`__. To build the PDF version of the
122 122 documentation, you need `pdflatex`, `latexmk`, and a fairly complete
123 123 LaTeX installation. Detailed requirements can be found in the Sphinx
... ... @@ -3650,6 +3650,16 @@ For a detailed list of changes, please see the file
3650 3650 and ``qpdf_replace_object``, exposing the corresponding methods
3651 3651 in ``QPDF`` and ``QPDFObjectHandle``.
3652 3652  
  3653 + - Documentation change
  3654 +
  3655 + - The documentation sources have been switched from docbook to
  3656 + reStructuredText processed with `Sphinx
  3657 + <https://sphinx-doc.org>`__. This is mostly transparent (other
  3658 + than format change) with the exception that all section links
  3659 + have changed. What used to be `#ref.something` is now
  3660 + `#something`. A top-to-bottom review of the documentation is
  3661 + planned for an upcoming release.
  3662 +
3653 3663 10.4.0: November 16, 2021
3654 3664 - Handling of Weak Cryptography Algorithms
3655 3665  
... ...