44 < meta charset ="utf-8 " /> < meta name ="generator " content ="Docutils 0.17.1: http://docutils.sourceforge.net/ " />
55
66 < meta name ="viewport " content ="width=device-width, initial-scale=1.0 " />
7- < title > README — pyvips 2.2.0 documentation</ title >
7+ < title > README — pyvips 2.2.1 documentation</ title >
88 < link rel ="stylesheet " href ="_static/pygments.css " type ="text/css " />
99 < link rel ="stylesheet " href ="_static/css/theme.css " type ="text/css " />
1010 <!--[if lt IE 9]>
1414 < script data-url_root ="./ " id ="documentation_options " src ="_static/documentation_options.js "> </ script >
1515 < script src ="_static/jquery.js "> </ script >
1616 < script src ="_static/underscore.js "> </ script >
17+ < script src ="_static/_sphinx_javascript_frameworks_compat.js "> </ script >
1718 < script src ="_static/doctools.js "> </ script >
1819 < script src ="_static/collapse.js "> </ script >
1920 < script src ="_static/js/theme.js "> </ script >
9495 < div itemprop ="articleBody ">
9596
9697 < section id ="readme ">
97- < h1 > README< a class ="headerlink " href ="#readme " title ="Permalink to this headline "> ¶</ a > </ h1 >
98+ < h1 > README< a class ="headerlink " href ="#readme " title ="Permalink to this heading "> ¶</ a > </ h1 >
9899< a class ="reference external image-reference " href ="https://travis-ci.org/libvips/pyvips "> < img alt ="Build Status " src ="https://travis-ci.org/libvips/pyvips.svg?branch=master " /> </ a >
99100< p > PyPI package:</ p >
100101< p > < a class ="reference external " href ="https://pypi.python.org/pypi/pyvips "> https://pypi.python.org/pypi/pyvips</ a > </ p >
@@ -116,7 +117,7 @@ <h1>README<a class="headerlink" href="#readme" title="Permalink to this headline
116117< p > This binding passes the vips test suite cleanly and with no leaks under
117118python2.7 - python3.6, pypy and pypy3 on Windows, macOS and Linux.</ p >
118119< section id ="how-it-works ">
119- < h2 > How it works< a class ="headerlink " href ="#how-it-works " title ="Permalink to this headline "> ¶</ a > </ h2 >
120+ < h2 > How it works< a class ="headerlink " href ="#how-it-works " title ="Permalink to this heading "> ¶</ a > </ h2 >
120121< p > Programs that use < code class ="docutils literal notranslate "> < span class ="pre "> pyvips</ span > </ code > don’t manipulate images directly, instead
121122they create pipelines of image processing operations building on a source
122123image. When the end of the pipe is connected to a destination, the whole
@@ -134,14 +135,14 @@ <h2>How it works<a class="headerlink" href="#how-it-works" title="Permalink to t
134135< p > < a class ="reference external " href ="http://libvips.github.io/libvips/API/current/How-it-opens-files.md.html "> http://libvips.github.io/libvips/API/current/How-it-opens-files.md.html</ a > </ p >
135136</ section >
136137< section id ="conda-install ">
137- < h2 > conda Install< a class ="headerlink " href ="#conda-install " title ="Permalink to this headline "> ¶</ a > </ h2 >
138+ < h2 > conda Install< a class ="headerlink " href ="#conda-install " title ="Permalink to this heading "> ¶</ a > </ h2 >
138139< p > The conda package includes a matching libvips binary, so just enter:</ p >
139140< div class ="highlight-shell notranslate "> < div class ="highlight "> < pre > < span > </ span > $ conda install --channel conda-forge pyvips
140141</ pre > </ div >
141142</ div >
142143</ section >
143144< section id ="non-conda-install ">
144- < h2 > Non-conda install< a class ="headerlink " href ="#non-conda-install " title ="Permalink to this headline "> ¶</ a > </ h2 >
145+ < h2 > Non-conda install< a class ="headerlink " href ="#non-conda-install " title ="Permalink to this heading "> ¶</ a > </ h2 >
145146< p > First, you need the libvips shared library on your library search path, version
1461478.2 or later, though at least version 8.9 is required for all features to work.
147148On Linux and macOS, you can just install via your package manager; on Windows you
@@ -169,7 +170,7 @@ <h2>Non-conda install<a class="headerlink" href="#non-conda-install" title="Perm
169170< p > Now when you import pyvips, it should be able to find the DLLs.</ p >
170171</ section >
171172< section id ="example ">
172- < h2 > Example< a class ="headerlink " href ="#example " title ="Permalink to this headline "> ¶</ a > </ h2 >
173+ < h2 > Example< a class ="headerlink " href ="#example " title ="Permalink to this heading "> ¶</ a > </ h2 >
173174< p > This sample program loads a JPG image, doubles the value of every green pixel,
174175sharpens, and then writes the image back to the filesystem again:</ p >
175176< div class ="highlight-python notranslate "> < div class ="highlight "> < pre > < span > </ span > < span class ="kn "> import</ span > < span class ="nn "> pyvips</ span >
@@ -186,7 +187,7 @@ <h2>Example<a class="headerlink" href="#example" title="Permalink to this headli
186187</ div >
187188</ section >
188189< section id ="notes ">
189- < h2 > Notes< a class ="headerlink " href ="#notes " title ="Permalink to this headline "> ¶</ a > </ h2 >
190+ < h2 > Notes< a class ="headerlink " href ="#notes " title ="Permalink to this heading "> ¶</ a > </ h2 >
190191< p > Local user install:</ p >
191192< div class ="highlight-shell notranslate "> < div class ="highlight "> < pre > < span > </ span > $ pip3 install -e .
192193$ pypy -m pip --user -e .
@@ -210,20 +211,29 @@ <h2>Notes<a class="headerlink" href="#notes" title="Permalink to this headline">
210211</ pre > </ div >
211212</ div >
212213< p > Stylecheck:</ p >
213- < div class ="highlight-shell notranslate "> < div class ="highlight "> < pre > < span > </ span > $ pytest -- flake8
214+ < div class ="highlight-shell notranslate "> < div class ="highlight "> < pre > < span > </ span > $ flake8
214215</ pre > </ div >
215216</ div >
216217< p > Generate HTML docs in < code class ="docutils literal notranslate "> < span class ="pre "> doc/build/html</ span > </ code > :</ p >
217218< div class ="highlight-shell notranslate "> < div class ="highlight "> < pre > < span > </ span > $ < span class ="nb "> cd</ span > doc< span class ="p "> ;</ span > sphinx-build -bhtml . build/html
218219</ pre > </ div >
219220</ div >
221+ < p > Regenerate enums:</ p >
222+ < p > Make sure you have installed a libvips with all optional packages enabled,
223+ then</ p >
224+ < div class ="highlight-shell notranslate "> < div class ="highlight "> < pre > < span > </ span > $ < span class ="nb "> cd</ span > examples< span class ="p "> ;</ span > < span class ="se "> \</ span >
225+ ./gen-enums.py ~/GIT/libvips/libvips/Vips-8.0.gir > enums.py
226+ </ pre > </ div >
227+ </ div >
228+ < p > Then check and move < cite > enums.py</ cite > into < cite > pyvips/</ cite > .</ p >
220229< p > Regenerate autodocs:</ p >
230+ < p > Make sure you have installed a libvips with all optional packages enabled,
231+ then</ p >
221232< div class ="highlight-shell notranslate "> < div class ="highlight "> < pre > < span > </ span > $ < span class ="nb "> cd</ span > doc< span class ="p "> ;</ span > < span class ="se "> \</ span >
222233 python3 -c < span class ="s2 "> "import pyvips; pyvips.Operation.generate_sphinx_all()"</ span > > x
223234</ pre > </ div >
224235</ div >
225- < p > And copy-paste < code class ="docutils literal notranslate "> < span class ="pre "> x</ span > </ code > into the obvious place in < code class ="docutils literal notranslate "> < span class ="pre "> doc/vimage.rst</ span > </ code > . See
226- < cite > examples/gen-enums.py</ cite > to regenerate all enums.</ p >
236+ < p > And copy-paste < code class ="docutils literal notranslate "> < span class ="pre "> x</ span > </ code > into the obvious place in < code class ="docutils literal notranslate "> < span class ="pre "> doc/vimage.rst</ span > </ code > .</ p >
227237< p > Update version number:</ p >
228238< div class ="highlight-shell notranslate "> < div class ="highlight "> < pre > < span > </ span > $ vi pyvips/version.py
229239$ vi doc/conf.py
0 commit comments