From: Akira Yokosawa <akiyks@gmail.com>
To: Jonathan Corbet <corbet@lwn.net>
Cc: linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org,
Akira Yokosawa <akiyks@gmail.com>
Subject: [PATCH 0/5] docs: pdfdocs: Improve LaTeX preamble (TOC, CJK fonts)
Date: Tue, 1 Feb 2022 08:56:29 +0900 [thread overview]
Message-ID: <b5b948b7-8e41-3bd6-1a52-44785c89c965@gmail.com> (raw)
Hi,
This is a follow-up series to the CJK font setting patch series [1]
upstreamed in v5.15.
[1]: https://lore.kernel.org/r/39d0fb0f-b248-bca4-2dac-df69e8d697b1@gmail.com
There is still a lot of room for improvement in the layout of PDF docs.
This series resolves issues listed below:
1. Some of chapter and section counts in Table of Contents (TOC) in
large PDF docs collide with chapter/section titles, e.g., Chapters 10,
11, 12, and 13 and Section 10.10 in userspace-api.pdf.
2. In docs of more than 99 pages, page counts in TOC are not aligned
properly when maxdepth >= 2 is specified in toctree, e.g., Chapters 10,
12, and 13 in userspace-api.pdf
3. In TOC of Latin-script docs, quotation and apostrophe symbols look too
wide, e.g., Section 2.2 in userspace-api.pdf.
4. In TOC of translations, Korean chapter titles lose inter-phrase spaces.
5. On systems without "Noto Sans CJK" fonts, CJK chapters in translations
results in full of "TOFU" boxes, with a long build time and a large
log file containing lots of missing-font warnings.
6. In translations.pdf built by "make pdfdocs", ascii-art diagrams in CJK
are not aligned properly.
Patch 1/5 resolves issues #1 and #2 by tweaking width parameters for TOC.
Patch 2/5 resolves issue #3 by switching CJK default font to the KR variant,
whose quotation and apostrophe symbols are half width.
Patch 3/5 resolves issue #4 by enabling CJKspace in TOC by default.
Patch 4/5 resolves issue #5 by conditionally skipping CJK contents in
PDF docs.
Patch 5/5 resolves issue #6 by moving font settings under
translations/conf.py to CJK-specific macros in main conf.py
This series is tested against Sphinx versions 1.7.9, 2.4.4, and 4.4.0.
It does not affect HTML docs.
Thanks, Akira
--
Akira Yokosawa (5):
docs: pdfdocs: Tweak width params of TOC
docs: pdfdocs: Switch default CJK font to KR variants
docs: pdfdocs: Enable CJKspace in TOC for Korean titles
docs/translations: Skip CJK contents if suitable fonts not found
docs: pdfdocs: Move CJK monospace font setting to main conf.py
Documentation/conf.py | 81 ++++++++++++++++++----
Documentation/translations/conf.py | 12 ----
Documentation/translations/ja_JP/index.rst | 4 +-
Documentation/translations/ko_KR/index.rst | 5 +-
Documentation/translations/zh_CN/index.rst | 4 +-
Documentation/translations/zh_TW/index.rst | 4 +-
6 files changed, 75 insertions(+), 35 deletions(-)
delete mode 100644 Documentation/translations/conf.py
base-commit: 854d0982eef0e424e8108d09d9275aaf445b1597
--
2.17.1
next reply other threads:[~2022-01-31 23:56 UTC|newest]
Thread overview: 10+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-01-31 23:56 Akira Yokosawa [this message]
2022-01-31 23:59 ` [PATCH 1/5] docs: pdfdocs: Tweak width params of TOC Akira Yokosawa
2022-02-01 0:02 ` [PATCH 2/5] docs: pdfdocs: Switch default CJK font to KR variants Akira Yokosawa
2022-02-01 0:03 ` [PATCH 3/5] docs: pdfdocs: Enable CJKspace in TOC for Korean titles Akira Yokosawa
2022-02-01 0:04 ` [PATCH 4/5] docs/translations: Skip CJK contents if suitable fonts not found Akira Yokosawa
2022-02-01 0:05 ` [PATCH 5/5] docs: pdfdocs: Move CJK monospace font setting to main conf.py Akira Yokosawa
2022-02-15 23:46 ` [PATCH 0/5] docs: pdfdocs: Improve LaTeX preamble (TOC, CJK fonts) Jonathan Corbet
2022-02-16 13:00 ` Akira Yokosawa
2022-02-17 14:21 ` Akira Yokosawa
2022-02-17 16:34 ` Jonathan Corbet
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=b5b948b7-8e41-3bd6-1a52-44785c89c965@gmail.com \
--to=akiyks@gmail.com \
--cc=corbet@lwn.net \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).