UnrealXR/raylib-python-cffi
Archived
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

add source build docs

Browse source
This commit is contained in:
richard 2021-08-27 04:03:12 +01:00
parent c59f68b75f
commit d167b1fee3
18 changed files with 44 additions and 11 deletions
Download patch file Download diff file Expand all files Collapse all files

BIN
docs-src/_build/doctrees/BUILDING.doctree
View file

Binary file not shown.

BIN
docs-src/_build/doctrees/environment.pickle
View file

Binary file not shown.

BIN
docs-src/_build/doctrees/index.doctree
View file

Binary file not shown.

1
docs-src/index.rst
View file

@ -14,6 +14,7 @@ Raylib Python
pyray
raylib
dynamic
BUILDING
* :ref:`search`

37
docs/BUILDING.html
View file

@ -7,7 +7,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Have Pip build from source &mdash; Raylib Python documentation</title>
<title>Building from source &mdash; Raylib Python documentation</title>
@ -41,7 +41,8 @@
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="prev" title="raylib.dynamic" href="dynamic.html" />
</head>
<body class="wy-body-for-nav">
@ -87,7 +88,7 @@
<p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
<ul>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="README.html">Python Bindings for Raylib 3.7</a></li>
<li class="toctree-l1"><a class="reference internal" href="README.html#install">Install</a></li>
<li class="toctree-l1"><a class="reference internal" href="README.html#how-to-use">How to use</a></li>
@ -99,6 +100,16 @@
<li class="toctree-l1"><a class="reference internal" href="pyray.html">raylib.pyray</a></li>
<li class="toctree-l1"><a class="reference internal" href="raylib.html">raylib.static</a></li>
<li class="toctree-l1"><a class="reference internal" href="dynamic.html">raylib.dynamic</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">Building from source</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#have-pip-build-from-source">Have Pip build from source</a></li>
<li class="toctree-l2"><a class="reference internal" href="#build-from-source-manually">Build from source manually</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#windows-manual-build">Windows manual build</a></li>
<li class="toctree-l3"><a class="reference internal" href="#linux-etc-manual-build">Linux etc manual build</a></li>
<li class="toctree-l3"><a class="reference internal" href="#raspberry-pi">Raspberry Pi</a></li>
</ul>
</li>
</ul>
</li>
</ul>
@ -147,7 +158,7 @@
<li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
<li>Have Pip build from source</li>
<li>Building from source</li>
<li class="wy-breadcrumbs-aside">
@ -166,8 +177,10 @@
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="have-pip-build-from-source">
<h1>Have Pip build from source<a class="headerlink" href="#have-pip-build-from-source" title="Permalink to this headline"></a></h1>
<div class="tex2jax_ignore mathjax_ignore section" id="building-from-source">
<h1>Building from source<a class="headerlink" href="#building-from-source" title="Permalink to this headline"></a></h1>
<div class="section" id="have-pip-build-from-source">
<h2>Have Pip build from source<a class="headerlink" href="#have-pip-build-from-source" title="Permalink to this headline"></a></h2>
<p>Useful if the binaries don’t work on your system.</p>
<p>Make sure Raylib is installed and then:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>pip3 install --no-binary raylib --upgrade --force-reinstall raylib
@ -175,13 +188,13 @@
</div>
</div>
<div class="section" id="build-from-source-manually">
<h1>Build from source manually<a class="headerlink" href="#build-from-source-manually" title="Permalink to this headline"></a></h1>
<h2>Build from source manually<a class="headerlink" href="#build-from-source-manually" title="Permalink to this headline"></a></h2>
<p>Useful if the Pip build doesn’t work, or you want to contribute to the project, or you want to skip building the
static lib and just <em>use the dynamic binding with your own dll</em>.</p>
<p>If you do build on a new platform please
submit your binaries as a PR.</p>
<div class="section" id="windows-manual-build">
<h2>Windows manual build<a class="headerlink" href="#windows-manual-build" title="Permalink to this headline"></a></h2>
<h3>Windows manual build<a class="headerlink" href="#windows-manual-build" title="Permalink to this headline"></a></h3>
<p>Clone this repo including submodules so you get correct version of Raylib.</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>git clone --recurse-submodules https://github.com/electronstudio/raylib-python-cffi
</pre></div>
@ -218,7 +231,7 @@ python setup.py bdist_wheel
<p>(Note: your wheel’s filename will probably be different than the one here.)</p>
</div>
<div class="section" id="linux-etc-manual-build">
<h2>Linux etc manual build<a class="headerlink" href="#linux-etc-manual-build" title="Permalink to this headline"></a></h2>
<h3>Linux etc manual build<a class="headerlink" href="#linux-etc-manual-build" title="Permalink to this headline"></a></h3>
<p>These instructions have been tested on Ubuntu 20.10 and 16.04. Mac should be very similar.</p>
<p>Clone this repo including submodules so you get correct version of Raylib.</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>git clone --recurse-submodules https://github.com/electronstudio/raylib-python-cffi
@ -276,7 +289,7 @@ please run <code class="docutils literal notranslate"><span class="pre">./raylib
<p>(TODO move the dynamic libs into a separate package rather than include them with every one.)</p>
</div>
<div class="section" id="raspberry-pi">
<h2>Raspberry Pi<a class="headerlink" href="#raspberry-pi" title="Permalink to this headline"></a></h2>
<h3>Raspberry Pi<a class="headerlink" href="#raspberry-pi" title="Permalink to this headline"></a></h3>
<p>The integrated GPU hardware in a Raspberry Pi (“VideoCore”) is rather
idiosyncratic, resulting in a complex set of software options. Probably the
most interesting two options for Raylib applications are:</p>
@ -298,6 +311,7 @@ modifications:</p>
</ul>
<p>(See <a class="reference external" href="https://github.com/electronstudio/raylib-python-cffi/issues/31#issuecomment-862078330">here</a> for a Raspberry Pi wheel)</p>
</div>
</div>
</div>
@ -305,6 +319,9 @@ modifications:</p>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="dynamic.html" class="btn btn-neutral float-left" title="raylib.dynamic" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
</div>
<hr/>

1
docs/README.html
View file

@ -109,6 +109,7 @@
<li class="toctree-l1"><a class="reference internal" href="pyray.html">raylib.pyray</a></li>
<li class="toctree-l1"><a class="reference internal" href="raylib.html">raylib.static</a></li>
<li class="toctree-l1"><a class="reference internal" href="dynamic.html">raylib.dynamic</a></li>
<li class="toctree-l1"><a class="reference internal" href="BUILDING.html">Building from source</a></li>
</ul>

2
docs/_sources/BUILDING.md.txt
View file

@ -1,3 +1,5 @@
# Building from source
## Have Pip build from source
Useful if the binaries don't work on your system.

1
docs/_sources/index.rst.txt
View file

@ -14,6 +14,7 @@ Raylib Python
pyray
raylib
dynamic
BUILDING
* :ref:`search`

3
docs/dynamic.html
View file

@ -42,6 +42,7 @@
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="Building from source" href="BUILDING.html" />
<link rel="prev" title="raylib.static" href="raylib.html" />
</head>
@ -100,6 +101,7 @@
<li class="toctree-l1"><a class="reference internal" href="pyray.html">raylib.pyray</a></li>
<li class="toctree-l1"><a class="reference internal" href="raylib.html">raylib.static</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">raylib.dynamic</a></li>
<li class="toctree-l1"><a class="reference internal" href="BUILDING.html">Building from source</a></li>
</ul>
@ -191,6 +193,7 @@ But the dynamic bindings have the big advantage that you don’t need to compile
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="BUILDING.html" class="btn btn-neutral float-right" title="Building from source" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
<a href="raylib.html" class="btn btn-neutral float-left" title="raylib.static" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
</div>

1
docs/generated/raylib.pyray.PyRay.html
View file

@ -99,6 +99,7 @@
<li class="toctree-l1"><a class="reference internal" href="../pyray.html">raylib.pyray</a></li>
<li class="toctree-l1"><a class="reference internal" href="../raylib.html">raylib.static</a></li>
<li class="toctree-l1"><a class="reference internal" href="../dynamic.html">raylib.dynamic</a></li>
<li class="toctree-l1"><a class="reference internal" href="../BUILDING.html">Building from source</a></li>
</ul>

1
docs/genindex.html
View file

@ -99,6 +99,7 @@
<li class="toctree-l1"><a class="reference internal" href="pyray.html">raylib.pyray</a></li>
<li class="toctree-l1"><a class="reference internal" href="raylib.html">raylib.static</a></li>
<li class="toctree-l1"><a class="reference internal" href="dynamic.html">raylib.dynamic</a></li>
<li class="toctree-l1"><a class="reference internal" href="BUILDING.html">Building from source</a></li>
</ul>

2
docs/index.html
View file

@ -100,6 +100,7 @@
<li class="toctree-l1"><a class="reference internal" href="pyray.html">raylib.pyray</a></li>
<li class="toctree-l1"><a class="reference internal" href="raylib.html">raylib.static</a></li>
<li class="toctree-l1"><a class="reference internal" href="dynamic.html">raylib.dynamic</a></li>
<li class="toctree-l1"><a class="reference internal" href="BUILDING.html">Building from source</a></li>
</ul>
@ -183,6 +184,7 @@
<li class="toctree-l1"><a class="reference internal" href="pyray.html">raylib.pyray</a></li>
<li class="toctree-l1"><a class="reference internal" href="raylib.html">raylib.static</a></li>
<li class="toctree-l1"><a class="reference internal" href="dynamic.html">raylib.dynamic</a></li>
<li class="toctree-l1"><a class="reference internal" href="BUILDING.html">Building from source</a></li>
</ul>
</div>
<ul class="simple">

BIN
docs/objects.inv
View file

Binary file not shown.

1
docs/py-modindex.html
View file

@ -102,6 +102,7 @@
<li class="toctree-l1"><a class="reference internal" href="pyray.html">raylib.pyray</a></li>
<li class="toctree-l1"><a class="reference internal" href="raylib.html">raylib.static</a></li>
<li class="toctree-l1"><a class="reference internal" href="dynamic.html">raylib.dynamic</a></li>
<li class="toctree-l1"><a class="reference internal" href="BUILDING.html">Building from source</a></li>
</ul>

1
docs/pyray.html
View file

@ -917,6 +917,7 @@
</li>
<li class="toctree-l1"><a class="reference internal" href="raylib.html">raylib.static</a></li>
<li class="toctree-l1"><a class="reference internal" href="dynamic.html">raylib.dynamic</a></li>
<li class="toctree-l1"><a class="reference internal" href="BUILDING.html">Building from source</a></li>
</ul>

1
docs/raylib.html
View file

@ -568,6 +568,7 @@
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="dynamic.html">raylib.dynamic</a></li>
<li class="toctree-l1"><a class="reference internal" href="BUILDING.html">Building from source</a></li>
</ul>

1
docs/search.html
View file

@ -102,6 +102,7 @@
<li class="toctree-l1"><a class="reference internal" href="pyray.html">raylib.pyray</a></li>
<li class="toctree-l1"><a class="reference internal" href="raylib.html">raylib.static</a></li>
<li class="toctree-l1"><a class="reference internal" href="dynamic.html">raylib.dynamic</a></li>
<li class="toctree-l1"><a class="reference internal" href="BUILDING.html">Building from source</a></li>
</ul>

2
docs/searchindex.js
View file

File diff suppressed because one or more lines are too long