• Show log

    Commit

  • Hash : 1fd31487
    Author : Nikhil Ramakrishnan
    Date : 2020-03-21T20:17:17

    [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.

  • README

  • After saying `make refdoc' or `make refdoc-venv' the `site/' directory
    contains the FreeType API reference.  You need Python >= 3.5 and pip to make
    this target.
    
    There are two ways to generate the documentation:
    
    1. Using `make refdoc':
    
        - Ensure `python' and `pip' are available.
        - Install pip package `docwriter' with `pip install --user docwriter'.
        - Make target with `make refdoc'.
        - This target can be run offline once required packages are installed.
    
    2. Using `make refdoc-venv' (requires internet access):
    
        - 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.
    
    This also works with Jam: Just type `jam refdoc' in the main directory.
    
    Some troubleshooting tips:
    
    * Regularly run `pip install --upgrade docwriter' to check for updates which
    may include bug fixes.
    
    * `Docwriter' does not support Python 2.  Ensure that Python >= 3.5 is
    installed and available as `python3'/`python'.
    
    * 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'.