docs/index.rst

.. SPDX-FileCopyrightText: 2022 James R. Barlow
..
.. SPDX-License-Identifier: CC-BY-SA-4.0

OCRmyPDF documentation
======================

.. figure:: images/logo.svg

OCRmyPDF adds an optical character recognition (OCR) text layer to scanned PDF
files, allowing them to be searched.

PDF is the best format for storing and exchanging scanned documents.
Unfortunately, PDFs can be difficult to modify. OCRmyPDF makes it easy to apply
image processing and OCR (recognized, searchable text) to existing PDFs.

.. toctree::
   :maxdepth: 1

   introduction
   release_notes
   installation
   languages
   jbig2

.. toctree::
   :caption: Usage
   :maxdepth: 2

   cookbook
   optimizer
   docker
   advanced
   batch
   cloud
   performance
   pdfsecurity
   errors

.. toctree::
   :caption: Developers
   :maxdepth: 2

   api
   plugins
   apiref
   design_notes
   contributing
   maintainers

Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
Change to SPDX license tracking 2022-07-28 01:06:46 -07:00			`.. SPDX-FileCopyrightText: 2022 James R. Barlow`
			`..`
			`.. SPDX-License-Identifier: CC-BY-SA-4.0`

Start the documentation 2016-09-06 13:52:40 -07:00			`OCRmyPDF documentation`
			`======================`

docs: show logo 2021-09-26 23:40:54 -07:00			`.. figure:: images/logo.svg`

fix typo "charcter" -> "character" (#673 ) 2020-11-09 19:53:02 -05:00			`OCRmyPDF adds an optical character recognition (OCR) text layer to scanned PDF`
docs: some mild improvements 2020-02-25 22:23:58 -08:00			`files, allowing them to be searched.`
Start the documentation 2016-09-06 13:52:40 -07:00
docs: improvements for Windows 2019-12-09 21:39:01 -08:00			`PDF is the best format for storing and exchanging scanned documents.`
			`Unfortunately, PDFs can be difficult to modify. OCRmyPDF makes it easy to apply`
Innocuous change to bump tag 2023-09-26 12:25:02 -07:00			`image processing and OCR (recognized, searchable text) to existing PDFs.`
Start the documentation 2016-09-06 13:52:40 -07:00
			`.. toctree::`
Move release notes into the rest of documentation 2017-04-18 18:26:31 -07:00			`:maxdepth: 1`
Start the documentation 2016-09-06 13:52:40 -07:00
			`introduction`
Move release notes into the rest of documentation 2017-04-18 18:26:31 -07:00			`release_notes`
Start the documentation 2016-09-06 13:52:40 -07:00			`installation`
			`languages`
Regroup installation page content around platforms 2018-08-03 12:47:25 -07:00			`jbig2`
Move release notes into the rest of documentation 2017-04-18 18:26:31 -07:00
			`.. toctree::`
			`:caption: Usage`
			`:maxdepth: 2`

Start the documentation 2016-09-06 13:52:40 -07:00			`cookbook`
docs: some reorganizing 2023-06-11 13:37:53 -07:00			`optimizer`
Docs: reorganize for new docker-alpine image 2019-03-01 23:15:32 -08:00			`docker`
More documentation updates 2017-01-28 15:35:59 -08:00			`advanced`
Additional docs updates for v4.4 2017-01-26 23:02:44 -08:00			`batch`
docs: some reorganizing 2023-06-11 13:37:53 -07:00			`cloud`
docs: Note about OCRmyPDF speed 2020-05-18 01:27:45 -07:00			`performance`
docs: rename security->pdfsecurity so github won't misinterpret it 2020-05-07 03:54:27 -07:00			`pdfsecurity`
More work on documentation 2016-10-28 01:22:40 -07:00			`errors`
Start the documentation 2016-09-06 13:52:40 -07:00
Add contributing guide 2019-09-20 17:02:22 -07:00			`.. toctree::`
			`:caption: Developers`
			`:maxdepth: 2`

			`api`
docs: plugin documentation 2020-05-07 03:53:37 -07:00			`plugins`
Improve API documentation 2020-06-30 04:20:14 -07:00			`apiref`
docs: various updates 2023-08-14 00:13:17 -07:00			`design_notes`
Add contributing guide 2019-09-20 17:02:22 -07:00			`contributing`
docs: new maintainer notes 2021-11-13 14:29:30 -08:00			`maintainers`
Start the documentation 2016-09-06 13:52:40 -07:00
			`Indices and tables`
			`==================`

			* :ref:`genindex`
			* :ref:`modindex`
			* :ref:`search`