qpdf/manual/index.rst

..
  Directives documentation:
  https://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html

qpdf version |release|
======================

..
  Include the actual text of the link to readthedocs so it shows up in
  the PDF when printed.

Welcome to the qpdf documentation! For the latest version of this
documentation, please visit `https://qpdf.readthedocs.io
<https://qpdf.readthedocs.io>`__.

..
  **REMEMBER** -- update CMakeLists.txt when new files are added.

.. toctree::
   :maxdepth: 2
   :caption: Contents:

   overview
   license
   download
   installation
   packaging
   cli
   qdf
   library
   weak-crypto
   json
   contributing
   design
   qpdf-job
   linearization
   object-streams
   encryption
   release-notes
   acknowledgement

Indices
=======

* :ref:`qpdf-options`
Add comment 2021-12-18 13:41:51 +00:00			`..`
			`Directives documentation:`
			`https://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html`
Create initial sphinx document sources Run sphinx-quickstart. Throw everything away except conf.py and index.rst. We will incorporate this into our own build system. 2021-12-11 21:36:05 +00:00
Standardize on "qpdf" Use "QPDF" only for the QPDF class itself. 2024-06-09 12:07:29 +00:00			`qpdf version \|release\|`
Sphinx docs: tweak output of sphinx-quickstart 2021-12-11 21:39:51 +00:00			`======================`
Create initial sphinx document sources Run sphinx-quickstart. Throw everything away except conf.py and index.rst. We will incorporate this into our own build system. 2021-12-11 21:36:05 +00:00
Reference latest docs on readthedocs 2021-12-20 22:16:39 +00:00			`..`
			`Include the actual text of the link to readthedocs so it shows up in`
			`the PDF when printed.`

Standardize on "qpdf" Use "QPDF" only for the QPDF class itself. 2024-06-09 12:07:29 +00:00			`Welcome to the qpdf documentation! For the latest version of this`
Reference latest docs on readthedocs 2021-12-20 22:16:39 +00:00			documentation, please visit `https://qpdf.readthedocs.io
			<https://qpdf.readthedocs.io>`__.

Add remimder to update list of files in CMakeLists.txt 2022-03-05 13:24:41 +00:00			`..`
			`REMEMBER -- update CMakeLists.txt when new files are added.`

Create initial sphinx document sources Run sphinx-quickstart. Throw everything away except conf.py and index.rst. We will incorporate this into our own build system. 2021-12-11 21:36:05 +00:00			`.. toctree::`
			`:maxdepth: 2`
			`:caption: Contents:`

Split documentation into multiple pages, change theme 2021-12-18 14:01:52 +00:00			`overview`
			`license`
Add download section to docs 2021-12-19 21:52:06 +00:00			`download`
Split documentation into multiple pages, change theme 2021-12-18 14:01:52 +00:00			`installation`
Stop adding pre-built documentation to the source distribution 2021-12-21 14:23:20 +00:00			`packaging`
Split documentation into multiple pages, change theme 2021-12-18 14:01:52 +00:00			`cli`
			`qdf`
			`library`
			`weak-crypto`
			`json`
Add documentation for code formatting and contribution guidelines 2022-04-09 16:22:46 +00:00			`contributing`
Split documentation into multiple pages, change theme 2021-12-18 14:01:52 +00:00			`design`
QPDFJob: documentation 2022-02-01 12:18:23 +00:00			`qpdf-job`
Split documentation into multiple pages, change theme 2021-12-18 14:01:52 +00:00			`linearization`
			`object-streams`
Generate help content from manual This is a massive rewrite of the help text and cli.rst section of the manual. All command-line flags now have their own help and are specifically index. qpdf --help is completely redone. 2022-01-11 16:49:33 +00:00			`encryption`
Split documentation into multiple pages, change theme 2021-12-18 14:01:52 +00:00			`release-notes`
			`acknowledgement`
Generate help content from manual This is a massive rewrite of the help text and cli.rst section of the manual. All command-line flags now have their own help and are specifically index. qpdf --help is completely redone. 2022-01-11 16:49:33 +00:00
			`Indices`
			`=======`

			* :ref:`qpdf-options`