From 3304498bdc7d70028d31fa53261cc6f5d7f1a530 Mon Sep 17 00:00:00 2001 From: "James R. Barlow" Date: Thu, 17 Apr 2025 15:43:36 -0700 Subject: [PATCH] Fix some anchors and markdown quirks --- docs/advanced.md | 1 - docs/cloud.md | 4 ++-- docs/conf.py | 12 +++--------- docs/introduction.md | 7 ------- docs/pdfsecurity.md | 2 +- 5 files changed, 6 insertions(+), 20 deletions(-) diff --git a/docs/advanced.md b/docs/advanced.md index 505067b5..65aacfc2 100644 --- a/docs/advanced.md +++ b/docs/advanced.md @@ -401,7 +401,6 @@ stable user interface. They may be imported from ``` (tmpdir)= - ## Changing temporary storage location OCRmyPDF generates many temporary files during processing. diff --git a/docs/cloud.md b/docs/cloud.md index 520df176..612ddeed 100644 --- a/docs/cloud.md +++ b/docs/cloud.md @@ -1,7 +1,7 @@ % SPDX-FileCopyrightText: 2025 James R. Barlow % SPDX-License-Identifier: CC-BY-SA-4.0 -{#ocr-service} +(ocr-service)= # Online deployments @@ -53,7 +53,7 @@ depending on the command line given. A rule of thumb would be to allow cloud servers or small VM partitions should be provisioned with plenty of extra space, if say, a 500 page file might be sent. -To change the temporary directory, see [tmpdir](advanced#tmpdir). +To change the temporary directory, see [tmpdir](#tmpdir). On Amazon Web Services or other cloud vendors, consider setting your temporary directory to [empheral diff --git a/docs/conf.py b/docs/conf.py index 301154ee..be811169 100755 --- a/docs/conf.py +++ b/docs/conf.py @@ -26,9 +26,7 @@ # -- General configuration ------------------------------------------------ -# If your documentation needs a minimal Sphinx version, state it here. -# -# needs_sphinx = '1.0' +needs_sphinx = '8' import datetime @@ -58,10 +56,6 @@ templates_path = ['_templates'] # The suffix(es) of source filenames. source_suffix = {'.rst': 'restructuredtext', '.md': 'markdown', '.txt': 'markdown'} -# The encoding of source files. -# -# source_encoding = 'utf-8-sig' - # The master toctree document. master_doc = 'index' @@ -70,8 +64,8 @@ project = 'ocrmypdf' year = str(datetime.date.today().year) copyright = ( - f'{year}, James R. Barlow. ', - 'Licensed under Creative Commons Attribution-ShareAlike 4.0.', + f'{year}, James R. Barlow. ' + + 'Licensed under Creative Commons Attribution-ShareAlike 4.0' ) author = 'James R. Barlow' diff --git a/docs/introduction.md b/docs/introduction.md index 45c38fc7..acc5c9d1 100644 --- a/docs/introduction.md +++ b/docs/introduction.md @@ -1,10 +1,3 @@ ---- -substitutions: - image: |- - ```{image} images/bitmap_vs_svg.svg - ``` ---- - % SPDX-FileCopyrightText: 2022 James R. Barlow % SPDX-License-Identifier: CC-BY-SA-4.0 diff --git a/docs/pdfsecurity.md b/docs/pdfsecurity.md index 73eb628e..4e0edfd1 100644 --- a/docs/pdfsecurity.md +++ b/docs/pdfsecurity.md @@ -1,4 +1,4 @@ -{#security} +(security)= # PDF security issues