Conversation
Documentation build overview
17 files changed ·
|
Co-authored-by: Stan Ulbrych <stan@python.org>
|
Vazirmatn is unmaintained following the death of its creator: Vazirharf is a maintained fork, is that suitable? In either case, the current .woff isn't too large at 109 KB, so bundling should be fine so we don't need to use a CDN. But Vazirmatn says:
Can we use the Non-Latin version? That'd reduce it by around half:
|
|
I don't oppose using a fork, but the font and its glyph coverage are stable, and the fork doesn't offer a benefit that matters for documentation (its only difference is how Lam-Alef is handled, which is aimed at typing sites). There's also no visible difference between the two, so I'd slightly lean towards staying with the original upstream release. That said, I'm happy to switch if the project prefers a maintained font, so I'll leave the decision to you. Good point on the Non-Latin build. Vazirmatn also has a variable-weight Non-Latin version, and it's slightly smaller than Vazirharf's: Please let me know what you think is best going forward, and thanks for the review! |
|
Let's stick with the original then, and go with that Non-Latin version. We can switch to a fork later if there's a concrete need to do so. Thanks! |
hugovk
left a comment
There was a problem hiding this comment.
Thanks! I added the version number in the title, so it'll go into the commit message, so we can easily check the version.
I think it'd be a very small fix, but should I make a separate PR for it, or fix it here if the scope creep is acceptable?
Let's do a new PR.
|
Thanks a lot for the review! I'll open a separate PR for that change. |
|
The CI is failing with |
|
I think we can just ignore the warning? |
for more information, see https://pre-commit.ci
|
Let's rather exclude, so we only have one copy in the expected place? Something this: build.targets.wheel.exclude = [ "python_docs_theme/locale/**/*.po", "python_docs_theme/static/fonts/OFL.txt" ]Ignoring W002 means we could easily end up with other duplicates in the future without realising. |
|
Makes sense. Excluded |
|
We can see the contents of the sdist at https://github.com/python/python-docs-theme/actions/runs/35627886765 It has the licence next to the font: And it also shows the wheel, with the licence in the designated But it doesn't need to be directly next to the font. The licence says:
|

Adds Vazirmatn for Farsi builds. Vazirmatn is an open-source font licensed under the SIL Open Font License. Adding this to Farsi builds improves the readability and quality of the documentation.
I didn't touch the broader RTL fonts and kept it scoped to Farsi with
:lang(fa). The font is bundled as a single variable WOFF2 file instatic/fonts/, with itsOFL.txtalongside.With Vazirmatn:


Before:


Please let me know if any changes or additions are needed. Thanks in advance!