Skip to content

Commit

Permalink
docs/vars.rst: update description of version information.
Browse files Browse the repository at this point in the history
  • Loading branch information
julian-smith-artifex-com committed Jun 3, 2024
1 parent 65bf009 commit 6683a18
Showing 1 changed file with 30 additions and 8 deletions.
38 changes: 30 additions & 8 deletions docs/vars.rst
Original file line number Diff line number Diff line change
Expand Up @@ -51,32 +51,54 @@ Constants

:rtype: int

.. py:data:: VersionBind
.. py.data:: mupdf_version
'x.xx.x' -- version of PyMuPDF (these bindings)
'x.xx.x' -- MuPDF version that is being used by PyMuPDF.
:rtype: string
.. py:data:: VersionFitz
.. py.data:: mupdf_version_tuple
MuPDF version as a tuple of integers, `(major, minor, patch)`.
:rtype: tuple
'x.xxx' -- version of MuPDF
.. py.data:: pymupdf_version
'x.xx.x' -- version of PyMuPDF (these bindings)
:rtype: string
.. py:data:: VersionDate
.. py.data:: pymupdf_version_tuple
PyMuPDF version as a tuple of integers, `(major, minor, patch)`.
:rtype: tuple
.. py:data:: pymupdf_date
ISO timestamp *YYYY-MM-DD HH:MM:SS* when these bindings were built.

:rtype: string

.. Note:: The docstring of *fitz* contains information of the above which can be retrieved like so: *print(fitz.__doc__)*, and should look like: *PyMuPDF 1.10.0: Python bindings for the MuPDF 1.10 library, built on 2016-11-30 13:09:13*.

.. py:data:: version
(VersionBind, VersionFitz, timestamp) -- combined version information where *timestamp* is the generation point in time formatted as "YYYYMMDDhhmmss".
(pymupdf_version, mupdf_version, timestamp) -- combined version information where `timestamp` is the generation point in time formatted as "YYYYMMDDhhmmss".

:rtype: tuple

.. py:data:: VersionBind
Legacy equivalent to `mupdf_version`.

.. py:data:: VersionFitz
Legacy equivalent to `pymupdf_version`.

.. py:data:: VersionDate
Legacy equivalent to `mupdf_version`.


.. _PermissionCodes:

Expand Down

0 comments on commit 6683a18

Please sign in to comment.