update docs
This commit is contained in:
parent
d167b1fee3
commit
64e5995633
11 changed files with 60 additions and 10 deletions
14
BUILDING.md
14
BUILDING.md
|
@ -1,3 +1,5 @@
|
||||||
|
# Building from source
|
||||||
|
|
||||||
## Have Pip build from source
|
## Have Pip build from source
|
||||||
|
|
||||||
Useful if the binaries don't work on your system.
|
Useful if the binaries don't work on your system.
|
||||||
|
@ -49,7 +51,11 @@ To build a binary wheel distribution:
|
||||||
pip3 install wheel
|
pip3 install wheel
|
||||||
python setup.py bdist_wheel
|
python setup.py bdist_wheel
|
||||||
|
|
||||||
and install it:
|
Alternatively, if you don't want the static binaries and just want to use DLLs with raylib.dynamic:
|
||||||
|
|
||||||
|
python3 setup_dynamic.py bdist_wheel
|
||||||
|
|
||||||
|
Then install it:
|
||||||
|
|
||||||
pip3 install dist\raylib-3.7.0-cp37-cp37m-win_amd64.whl
|
pip3 install dist\raylib-3.7.0-cp37-cp37m-win_amd64.whl
|
||||||
|
|
||||||
|
@ -104,7 +110,11 @@ To build a binary wheel distribution:
|
||||||
pip3 install wheel
|
pip3 install wheel
|
||||||
python3 setup.py bdist_wheel
|
python3 setup.py bdist_wheel
|
||||||
|
|
||||||
and install it:
|
Alternatively, if you don't want the static binaries and just want to use DLLs with raylib.dynamic:
|
||||||
|
|
||||||
|
python3 setup_dynamic.py bdist_wheel
|
||||||
|
|
||||||
|
Then install it:
|
||||||
|
|
||||||
pip3 install dist/raylib*.whl
|
pip3 install dist/raylib*.whl
|
||||||
|
|
||||||
|
|
Binary file not shown.
Binary file not shown.
Binary file not shown.
|
@ -3,13 +3,20 @@ raylib.dynamic
|
||||||
|
|
||||||
CFFI ABI dynamic bindings exist in order to avoid the need to compile a C extension module.
|
CFFI ABI dynamic bindings exist in order to avoid the need to compile a C extension module.
|
||||||
|
|
||||||
|
See https://github.com/electronstudio/raylib-python-cffi/blob/master/test_static.py for how to use.
|
||||||
|
|
||||||
Currently the github version may include bundled DLLs in ``raylib/dynamic`` but the pypi version requires a system installed Raylib.
|
Currently the github version may include bundled DLLs in ``raylib/dynamic`` but the pypi version requires a system installed Raylib.
|
||||||
You can put your own DLLs in ``raylib/dynamic`` if you prefer.
|
You can put your own DLLs in ``raylib/dynamic`` if you prefer.
|
||||||
|
|
||||||
If your system already has the Raylib library installed, you can set the environment variable ``USE_EXTERNAL_RAYLIB`` and it will
|
If your system already has the Raylib library installed, you can set the environment variable ``USE_EXTERNAL_RAYLIB`` and it will
|
||||||
always be used instead of the bundled DLLs.
|
always be used instead of the bundled DLLs.
|
||||||
|
|
||||||
See https://github.com/electronstudio/raylib-python-cffi/blob/master/test_static.py for how to use.
|
If you want to build your own wheel with just raylib.dynamic and not even attempt to compile the static libraries,
|
||||||
|
the command is::
|
||||||
|
|
||||||
|
python3 setup_dynamic.py bdist_wheel
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
.. warning::
|
.. warning::
|
||||||
|
|
||||||
|
|
|
@ -224,7 +224,11 @@ pip3 install wheel
|
||||||
python setup.py bdist_wheel
|
python setup.py bdist_wheel
|
||||||
</pre></div>
|
</pre></div>
|
||||||
</div>
|
</div>
|
||||||
<p>and install it:</p>
|
<p>Alternatively, if you don’t want the static binaries and just want to use DLLs with raylib.dynamic:</p>
|
||||||
|
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>python3 setup_dynamic.py bdist_wheel
|
||||||
|
</pre></div>
|
||||||
|
</div>
|
||||||
|
<p>Then install it:</p>
|
||||||
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>pip3 install dist\raylib-3.7.0-cp37-cp37m-win_amd64.whl
|
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>pip3 install dist\raylib-3.7.0-cp37-cp37m-win_amd64.whl
|
||||||
</pre></div>
|
</pre></div>
|
||||||
</div>
|
</div>
|
||||||
|
@ -276,7 +280,11 @@ cp -P /usr/local/lib/libraylib.so* raylib/dynamic/
|
||||||
python3 setup.py bdist_wheel
|
python3 setup.py bdist_wheel
|
||||||
</pre></div>
|
</pre></div>
|
||||||
</div>
|
</div>
|
||||||
<p>and install it:</p>
|
<p>Alternatively, if you don’t want the static binaries and just want to use DLLs with raylib.dynamic:</p>
|
||||||
|
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>python3 setup_dynamic.py bdist_wheel
|
||||||
|
</pre></div>
|
||||||
|
</div>
|
||||||
|
<p>Then install it:</p>
|
||||||
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>pip3 install dist/raylib*.whl
|
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>pip3 install dist/raylib*.whl
|
||||||
</pre></div>
|
</pre></div>
|
||||||
</div>
|
</div>
|
||||||
|
|
|
@ -51,7 +51,11 @@ To build a binary wheel distribution:
|
||||||
pip3 install wheel
|
pip3 install wheel
|
||||||
python setup.py bdist_wheel
|
python setup.py bdist_wheel
|
||||||
|
|
||||||
and install it:
|
Alternatively, if you don't want the static binaries and just want to use DLLs with raylib.dynamic:
|
||||||
|
|
||||||
|
python3 setup_dynamic.py bdist_wheel
|
||||||
|
|
||||||
|
Then install it:
|
||||||
|
|
||||||
pip3 install dist\raylib-3.7.0-cp37-cp37m-win_amd64.whl
|
pip3 install dist\raylib-3.7.0-cp37-cp37m-win_amd64.whl
|
||||||
|
|
||||||
|
@ -106,7 +110,11 @@ To build a binary wheel distribution:
|
||||||
pip3 install wheel
|
pip3 install wheel
|
||||||
python3 setup.py bdist_wheel
|
python3 setup.py bdist_wheel
|
||||||
|
|
||||||
and install it:
|
Alternatively, if you don't want the static binaries and just want to use DLLs with raylib.dynamic:
|
||||||
|
|
||||||
|
python3 setup_dynamic.py bdist_wheel
|
||||||
|
|
||||||
|
Then install it:
|
||||||
|
|
||||||
pip3 install dist/raylib*.whl
|
pip3 install dist/raylib*.whl
|
||||||
|
|
||||||
|
|
|
@ -3,13 +3,20 @@ raylib.dynamic
|
||||||
|
|
||||||
CFFI ABI dynamic bindings exist in order to avoid the need to compile a C extension module.
|
CFFI ABI dynamic bindings exist in order to avoid the need to compile a C extension module.
|
||||||
|
|
||||||
|
See https://github.com/electronstudio/raylib-python-cffi/blob/master/test_static.py for how to use.
|
||||||
|
|
||||||
Currently the github version may include bundled DLLs in ``raylib/dynamic`` but the pypi version requires a system installed Raylib.
|
Currently the github version may include bundled DLLs in ``raylib/dynamic`` but the pypi version requires a system installed Raylib.
|
||||||
You can put your own DLLs in ``raylib/dynamic`` if you prefer.
|
You can put your own DLLs in ``raylib/dynamic`` if you prefer.
|
||||||
|
|
||||||
If your system already has the Raylib library installed, you can set the environment variable ``USE_EXTERNAL_RAYLIB`` and it will
|
If your system already has the Raylib library installed, you can set the environment variable ``USE_EXTERNAL_RAYLIB`` and it will
|
||||||
always be used instead of the bundled DLLs.
|
always be used instead of the bundled DLLs.
|
||||||
|
|
||||||
See https://github.com/electronstudio/raylib-python-cffi/blob/master/test_static.py for how to use.
|
If you want to build your own wheel with just raylib.dynamic and not even attempt to compile the static libraries,
|
||||||
|
the command is::
|
||||||
|
|
||||||
|
python3 setup_dynamic.py bdist_wheel
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
.. warning::
|
.. warning::
|
||||||
|
|
||||||
|
|
|
@ -172,11 +172,16 @@
|
||||||
<div class="section" id="raylib-dynamic">
|
<div class="section" id="raylib-dynamic">
|
||||||
<h1>raylib.dynamic<a class="headerlink" href="#raylib-dynamic" title="Permalink to this headline">¶</a></h1>
|
<h1>raylib.dynamic<a class="headerlink" href="#raylib-dynamic" title="Permalink to this headline">¶</a></h1>
|
||||||
<p>CFFI ABI dynamic bindings exist in order to avoid the need to compile a C extension module.</p>
|
<p>CFFI ABI dynamic bindings exist in order to avoid the need to compile a C extension module.</p>
|
||||||
|
<p>See <a class="reference external" href="https://github.com/electronstudio/raylib-python-cffi/blob/master/test_static.py">https://github.com/electronstudio/raylib-python-cffi/blob/master/test_static.py</a> for how to use.</p>
|
||||||
<p>Currently the github version may include bundled DLLs in <code class="docutils literal notranslate"><span class="pre">raylib/dynamic</span></code> but the pypi version requires a system installed Raylib.
|
<p>Currently the github version may include bundled DLLs in <code class="docutils literal notranslate"><span class="pre">raylib/dynamic</span></code> but the pypi version requires a system installed Raylib.
|
||||||
You can put your own DLLs in <code class="docutils literal notranslate"><span class="pre">raylib/dynamic</span></code> if you prefer.</p>
|
You can put your own DLLs in <code class="docutils literal notranslate"><span class="pre">raylib/dynamic</span></code> if you prefer.</p>
|
||||||
<p>If your system already has the Raylib library installed, you can set the environment variable <code class="docutils literal notranslate"><span class="pre">USE_EXTERNAL_RAYLIB</span></code> and it will
|
<p>If your system already has the Raylib library installed, you can set the environment variable <code class="docutils literal notranslate"><span class="pre">USE_EXTERNAL_RAYLIB</span></code> and it will
|
||||||
always be used instead of the bundled DLLs.</p>
|
always be used instead of the bundled DLLs.</p>
|
||||||
<p>See <a class="reference external" href="https://github.com/electronstudio/raylib-python-cffi/blob/master/test_static.py">https://github.com/electronstudio/raylib-python-cffi/blob/master/test_static.py</a> for how to use.</p>
|
<p>If you want to build your own wheel with just raylib.dynamic and not even attempt to compile the static libraries,
|
||||||
|
the command is:</p>
|
||||||
|
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">python3</span> <span class="n">setup_dynamic</span><span class="o">.</span><span class="n">py</span> <span class="n">bdist_wheel</span>
|
||||||
|
</pre></div>
|
||||||
|
</div>
|
||||||
<div class="admonition warning">
|
<div class="admonition warning">
|
||||||
<p class="admonition-title">Warning</p>
|
<p class="admonition-title">Warning</p>
|
||||||
<p>There have been some weird failures with dynamic bindings and ctypes bindings before and often the
|
<p>There have been some weird failures with dynamic bindings and ctypes bindings before and often the
|
||||||
|
|
File diff suppressed because one or more lines are too long
5
make_docs.sh
Executable file
5
make_docs.sh
Executable file
|
@ -0,0 +1,5 @@
|
||||||
|
#!/usr/bin/bash
|
||||||
|
|
||||||
|
python3 create_stub.py > raylib/pyray.pyi
|
||||||
|
cd docs-src
|
||||||
|
make clean ; make html ; cp -a _build/html/. ../docs/
|
Reference in a new issue