diff options
| author | Nikhil Ramakrishnan <ramakrishnan.nikhil@gmail.com> | 2020-03-21 20:17:17 +0530 |
|---|---|---|
| committer | Nikhil Ramakrishnan <ramakrishnan.nikhil@gmail.com> | 2020-03-21 20:17:17 +0530 |
| commit | 1fd3148713def5fe72ff6844a33e4fc896a80780 (patch) | |
| tree | 951b7ff1cb4ad5fc4365a364870f62dfb8b8b5ad /docs | |
| parent | 6a431038c9113d906d66836cd7d216a5c630be7c (diff) | |
| download | freetype2-1fd3148713def5fe72ff6844a33e4fc896a80780.tar.gz | |
[docwriter] Drop support for Python < 3.5.
Python versions < 3.5 have reached end-of-life and as such, no
security or bug fixes will be provided for those versions. See
https://devguide.python.org/#status-of-python-branches
for more information.
* Jamfile (RefDoc): Add `site' parameter.
* builds/detect.mk (std_setup): Update Python version requirement.
* builds/freetype.mk (refdoc-venv): Use pip as `python -m pip'.
* builds/unix/ax_compare_version.m4,
builds/unix/ax_prog_python_version.m4: Macros to detect Python
version. New files.
* builds/unix/configure.raw: Check for Python >= 3.5 and remove
check for `pip'.
* docs/CHANGES, docs/INSTALL.GNU, docs/README: Updated.
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/CHANGES | 4 | ||||
| -rw-r--r-- | docs/INSTALL.GNU | 2 | ||||
| -rw-r--r-- | docs/README | 14 |
3 files changed, 12 insertions, 8 deletions
diff --git a/docs/CHANGES b/docs/CHANGES index eb3bb46c7..9704fca59 100644 --- a/docs/CHANGES +++ b/docs/CHANGES @@ -12,6 +12,10 @@ CHANGES BETWEEN 2.10.1 and 2.10.2 - Function `FT_Get_Var_Axis_Flags' returned random data for Type 1 MM fonts. + - Drop support for Python 2 in Freetype's API reference generator + `docwriter' (Python >= 3.5 is required for targets `make refdoc' + and `make refdoc-venv'). + ====================================================================== diff --git a/docs/INSTALL.GNU b/docs/INSTALL.GNU index d61e38757..8fdbb825e 100644 --- a/docs/INSTALL.GNU +++ b/docs/INSTALL.GNU @@ -63,7 +63,7 @@ instructions in the file `INSTALL.UNIX' instead. Otherwise, simply type 'make' again to build the library or 'make refdoc' to build the API reference (the latter needs - python). + Python >= 3.5). ============================================================= diff --git a/docs/README b/docs/README index 3ffcfc080..f82382d45 100644 --- a/docs/README +++ b/docs/README @@ -1,6 +1,6 @@ After saying `make refdoc' or `make refdoc-venv' the `site/' directory -contains the FreeType API reference. You need python and pip to make this -target. +contains the FreeType API reference. You need Python >= 3.5 and pip to make +this target. There are two ways to generate the documentation: @@ -13,7 +13,7 @@ There are two ways to generate the documentation: 2. Using `make refdoc-venv' (requires internet access): - - Ensure `python', `pip' and python package `virtualenv' are available. + - Ensure `python', `pip' and Python package `virtualenv' are available. - Make target with `make refdoc-venv'. - This may or may not require internet access every time depending on pip and system caching. @@ -25,11 +25,11 @@ Some troubleshooting tips: * Regularly run `pip install --upgrade docwriter' to check for updates which may include bug fixes. -* Ensure that `docwriter' is installed in the same python target that -`make refdoc' uses (python3/python2/python). +* `Docwriter' does not support Python 2. Ensure that Python >= 3.5 is +installed and available as `python3'/`python'. -* `pip' and `python' may point to different versions of Python. Check using -`python --version' and `pip --version'. +* Ensure that `docwriter' is installed in the same Python target that +`make refdoc' uses (python3/python). * If none of this works, send a mail to `freetype-devel@nongnu.org' or file an issue at `https://github.com/freetype/docwriter/issues'. |