Skip to content

Commit 1b4e3a7

Browse files
docs/pymupdf-pro.rst: added description of unlock()'s font args.
1 parent 4c579c0 commit 1b4e3a7

File tree

1 file changed

+15
-1
lines changed

1 file changed

+15
-1
lines changed

docs/pymupdf-pro.rst

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -132,6 +132,20 @@ Initialize |PyMuPDF Pro| with a key as follows:
132132
This will allow you to evaluate the product for a limited time. If you want to use |PyMuPDF Pro| after this time you should then `enquire about obtaining a commercial license <https://artifex.com/products/pymupdf-pro/>`_.
133133

134134

135+
Fonts
136+
-----------------------
137+
138+
By default `pymupdf.pro.unlock()` searches for all installed font directories.
139+
140+
This can be controlled with keyword-only args:
141+
142+
* `fontpath`: specific font directories, either as a list/tuple or `os.sep`-separated string.
143+
If None (the default), we use `os.environ['PYMUPDFPRO_FONT_PATH']` if set.
144+
* `fontpath_auto`: Whether to append system font directories.
145+
If None (the default) we use true if `os.environ['PYMUPDFPRO_FONT_PATH_AUTO']` is '1'.
146+
If true we append all system font directories.
147+
148+
Function `pymupdf.pro.get_fontpath()` returns a tuple of all font directories used by `unlock()`.
135149

136150

137151
.. raw:: html
@@ -142,4 +156,4 @@ This will allow you to evaluate the product for a limited time. If you want to u
142156

143157

144158

145-
.. include:: footer.rst
159+
.. include:: footer.rst

0 commit comments

Comments
 (0)