aboutsummaryrefslogtreecommitdiffstats
path: root/manual/index.rst
diff options
context:
space:
mode:
authorJay Berkenbilt <ejb@ql.org>2021-12-12 23:57:11 +0100
committerJay Berkenbilt <ejb@ql.org>2021-12-13 17:20:14 +0100
commit43740ea7336c88402c7b232a9bf783a798b32c94 (patch)
tree687bb12b29028b5d14b3623a072019c4bc1a21e9 /manual/index.rst
parent61f52cb6acc5848ad4a9b41c57bb15bbbae53163 (diff)
downloadqpdf-43740ea7336c88402c7b232a9bf783a798b32c94.tar.zst
ChangeLog/release note on doc change
Diffstat (limited to 'manual/index.rst')
-rw-r--r--manual/index.rst12
1 files changed, 11 insertions, 1 deletions
diff --git a/manual/index.rst b/manual/index.rst
index 882dd665..90fc8ca4 100644
--- a/manual/index.rst
+++ b/manual/index.rst
@@ -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