File: apiref.rst

package info (click to toggle)
ocrmypdf 16.7.0%2Bdfsg1-3
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 10,684 kB
  • sloc: python: 13,255; sh: 260; makefile: 22
file content (71 lines) | stat: -rw-r--r-- 1,216 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
.. SPDX-FileCopyrightText: 2022 James R. Barlow
..
.. SPDX-License-Identifier: CC-BY-SA-4.0

=============
API reference
=============

This page summarizes the rest of the public API. Generally speaking this
should be mainly of interest to plugin developers.

ocrmypdf
========

.. autoclass:: ocrmypdf.PageContext
    :members:

.. autoclass:: ocrmypdf.PdfContext
    :members:

.. autoclass:: ocrmypdf.Verbosity
    :members:
    :undoc-members:

.. autofunction:: ocrmypdf.configure_logging

.. autofunction:: ocrmypdf.ocr

.. autofunction:: ocrmypdf.pdf_to_hocr

.. autofunction:: ocrmypdf.hocr_to_ocr_pdf

ocrmypdf.exceptions
===================

.. automodule:: ocrmypdf.exceptions
    :members:
    :undoc-members:

ocrmypdf.helpers
================

.. automodule:: ocrmypdf.helpers
    :members:
    :noindex: deprecated

    .. autodecorator:: deprecated

ocrmypdf.hocrtransform
======================

.. automodule:: ocrmypdf.hocrtransform
    :members:

ocrmypdf.pdfa
=============

.. automodule:: ocrmypdf.pdfa
    :members:

ocrmypdf.quality
================

.. automodule:: ocrmypdf.quality
    :members:

ocrmypdf.subprocess
===================

.. automodule:: ocrmypdf.subprocess
    :members: