octoleo/qpdf
2
1
Fork 0
mirror of https://github.com/qpdf/qpdf.git synced 2024-11-04 20:37:50 +00:00
Code Issues Releases Wiki Activity
ce740d987f
qpdf/manual/conf.py

41 lines
1.0 KiB
Python
Raw Normal View History

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
# Configuration file for the Sphinx documentation builder.
#
Sphinx docs: tweak output of sphinx-quickstart
2021-12-11 21:39:51 +00:00
# This file only contains a selection of the most common options. For
# a full list see the documentation:
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
# https://www.sphinx-doc.org/en/master/usage/configuration.html
#
Sphinx docs: tweak output of sphinx-quickstart
2021-12-11 21:39:51 +00:00
# To see the default sample conf.py, run sphinx-quickstart in an empty
# directory. Most of the original comments and options were removed.
doc: switch html theme to sphinx_rtd_theme
2021-12-19 18:12:11 +00:00
import sphinx_rtd_theme # noQA F401
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
import os
import sys
sys.path.append(os.path.abspath("./_ext"))
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
project = 'QPDF'
Sphinx docs: tweak output of sphinx-quickstart
2021-12-11 21:39:51 +00:00
copyright = '2005-2021, Jay Berkenbilt'
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
author = 'Jay Berkenbilt'
Stop adding pre-built documentation to the source distribution
2021-12-21 14:23:20 +00:00
# make_dist and the CI build lexically find the release version from this file.
Prepare 10.5.0 release
2021-12-20 18:05:11 +00:00
release = '10.5.0'
Update configuration for correct building of epub
2021-12-18 20:59:04 +00:00
version = release
doc: switch html theme to sphinx_rtd_theme
2021-12-19 18:12:11 +00:00
extensions = [
'sphinx_rtd_theme',
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
'qpdf',
doc: switch html theme to sphinx_rtd_theme
2021-12-19 18:12:11 +00:00
]
html_theme = 'sphinx_rtd_theme'
Split documentation into multiple pages, change theme
2021-12-18 14:01:52 +00:00
html_theme_options = {
"body_max_width": None,
}
doc: switch html theme to sphinx_rtd_theme
2021-12-19 18:12:11 +00:00
html_logo = '../logo/qpdf.svg'
Manual: enable line wrapping in table cells
2022-01-17 12:22:35 +00:00
html_static_path = ['_static']
html_css_files = [
'css/wraptable.css',
]
Allow real <= and >= in LateX
2022-01-18 14:14:17 +00:00
latex_elements = {
'preamble': r'''
\sphinxDUC{2264}{$\leq$}
\sphinxDUC{2265}{$\geq$}
''',
}
Specify highlight language instead of using text codeblocks
2021-12-18 18:43:58 +00:00
highlight_language = 'none'
Copy Permalink