OCRmyPDF/docs/index.rst

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

OCRmyPDF adds an 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 to existing PDFs.

.. toctree::
   :maxdepth: 1

   introduction
   release_notes
   installation
   optimizer
   languages
   jbig2

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

   cookbook
   docker
   advanced
   batch
   security
   errors

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

   api
   contributing

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

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
Start the documentation 2016-09-06 13:52:40 -07:00			`OCRmyPDF documentation`
			`======================`

			`OCRmyPDF adds an OCR text layer to scanned PDF files, allowing them to`
			`be searched.`

Improve docs 2018-03-01 00:24:38 -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 image processing and OCR 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`
docs: document optimization 2019-11-08 03:22:28 -08:00			`optimizer`
Start the documentation 2016-09-06 13:52:40 -07:00			`languages`
Regroup installation page content around platforms Also separate out JBIG2 encoder instructions so that distributions that delete installation.rst won't omit this information. 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: 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`
Add security suggestions 2016-11-21 20:58:31 -08:00			`security`
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`
			`contributing`
Start the documentation 2016-09-06 13:52:40 -07:00
			`Indices and tables`
			`==================`

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