Skip to content

Commit d167b1f

Browse files
add source build docs
1 parent c59f68b commit d167b1f

18 files changed

+44
-11
lines changed
302 Bytes
Binary file not shown.
545 Bytes
Binary file not shown.
16 Bytes
Binary file not shown.

docs-src/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@ Raylib Python
1414
pyray
1515
raylib
1616
dynamic
17+
BUILDING
1718

1819

1920
* :ref:`search`

docs/BUILDING.html

Lines changed: 27 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77

88
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
99

10-
<title>Have Pip build from source &mdash; Raylib Python documentation</title>
10+
<title>Building from source &mdash; Raylib Python documentation</title>
1111

1212

1313

@@ -41,7 +41,8 @@
4141

4242

4343
<link rel="index" title="Index" href="genindex.html" />
44-
<link rel="search" title="Search" href="search.html" />
44+
<link rel="search" title="Search" href="search.html" />
45+
<link rel="prev" title="raylib.dynamic" href="dynamic.html" />
4546
</head>
4647

4748
<body class="wy-body-for-nav">
@@ -87,7 +88,7 @@
8788

8889

8990
<p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
90-
<ul>
91+
<ul class="current">
9192
<li class="toctree-l1"><a class="reference internal" href="README.html">Python Bindings for Raylib 3.7</a></li>
9293
<li class="toctree-l1"><a class="reference internal" href="README.html#install">Install</a></li>
9394
<li class="toctree-l1"><a class="reference internal" href="README.html#how-to-use">How to use</a></li>
@@ -99,6 +100,16 @@
99100
<li class="toctree-l1"><a class="reference internal" href="pyray.html">raylib.pyray</a></li>
100101
<li class="toctree-l1"><a class="reference internal" href="raylib.html">raylib.static</a></li>
101102
<li class="toctree-l1"><a class="reference internal" href="dynamic.html">raylib.dynamic</a></li>
103+
<li class="toctree-l1 current"><a class="current reference internal" href="#">Building from source</a><ul>
104+
<li class="toctree-l2"><a class="reference internal" href="#have-pip-build-from-source">Have Pip build from source</a></li>
105+
<li class="toctree-l2"><a class="reference internal" href="#build-from-source-manually">Build from source manually</a><ul>
106+
<li class="toctree-l3"><a class="reference internal" href="#windows-manual-build">Windows manual build</a></li>
107+
<li class="toctree-l3"><a class="reference internal" href="#linux-etc-manual-build">Linux etc manual build</a></li>
108+
<li class="toctree-l3"><a class="reference internal" href="#raspberry-pi">Raspberry Pi</a></li>
109+
</ul>
110+
</li>
111+
</ul>
112+
</li>
102113
</ul>
103114

104115

@@ -147,7 +158,7 @@
147158

148159
<li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
149160

150-
<li>Have Pip build from source</li>
161+
<li>Building from source</li>
151162

152163

153164
<li class="wy-breadcrumbs-aside">
@@ -166,22 +177,24 @@
166177
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
167178
<div itemprop="articleBody">
168179

169-
<div class="section" id="have-pip-build-from-source">
170-
<h1>Have Pip build from source<a class="headerlink" href="#have-pip-build-from-source" title="Permalink to this headline"></a></h1>
180+
<div class="tex2jax_ignore mathjax_ignore section" id="building-from-source">
181+
<h1>Building from source<a class="headerlink" href="#building-from-source" title="Permalink to this headline"></a></h1>
182+
<div class="section" id="have-pip-build-from-source">
183+
<h2>Have Pip build from source<a class="headerlink" href="#have-pip-build-from-source" title="Permalink to this headline"></a></h2>
171184
<p>Useful if the binaries don’t work on your system.</p>
172185
<p>Make sure Raylib is installed and then:</p>
173186
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>pip3 install --no-binary raylib --upgrade --force-reinstall raylib
174187
</pre></div>
175188
</div>
176189
</div>
177190
<div class="section" id="build-from-source-manually">
178-
<h1>Build from source manually<a class="headerlink" href="#build-from-source-manually" title="Permalink to this headline"></a></h1>
191+
<h2>Build from source manually<a class="headerlink" href="#build-from-source-manually" title="Permalink to this headline"></a></h2>
179192
<p>Useful if the Pip build doesn’t work, or you want to contribute to the project, or you want to skip building the
180193
static lib and just <em>use the dynamic binding with your own dll</em>.</p>
181194
<p>If you do build on a new platform please
182195
submit your binaries as a PR.</p>
183196
<div class="section" id="windows-manual-build">
184-
<h2>Windows manual build<a class="headerlink" href="#windows-manual-build" title="Permalink to this headline"></a></h2>
197+
<h3>Windows manual build<a class="headerlink" href="#windows-manual-build" title="Permalink to this headline"></a></h3>
185198
<p>Clone this repo including submodules so you get correct version of Raylib.</p>
186199
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>git clone --recurse-submodules https://github.com/electronstudio/raylib-python-cffi
187200
</pre></div>
@@ -218,7 +231,7 @@ <h2>Windows manual build<a class="headerlink" href="#windows-manual-build" title
218231
<p>(Note: your wheel’s filename will probably be different than the one here.)</p>
219232
</div>
220233
<div class="section" id="linux-etc-manual-build">
221-
<h2>Linux etc manual build<a class="headerlink" href="#linux-etc-manual-build" title="Permalink to this headline"></a></h2>
234+
<h3>Linux etc manual build<a class="headerlink" href="#linux-etc-manual-build" title="Permalink to this headline"></a></h3>
222235
<p>These instructions have been tested on Ubuntu 20.10 and 16.04. Mac should be very similar.</p>
223236
<p>Clone this repo including submodules so you get correct version of Raylib.</p>
224237
<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 @@ <h2>Linux etc manual build<a class="headerlink" href="#linux-etc-manual-build" t
276289
<p>(TODO move the dynamic libs into a separate package rather than include them with every one.)</p>
277290
</div>
278291
<div class="section" id="raspberry-pi">
279-
<h2>Raspberry Pi<a class="headerlink" href="#raspberry-pi" title="Permalink to this headline"></a></h2>
292+
<h3>Raspberry Pi<a class="headerlink" href="#raspberry-pi" title="Permalink to this headline"></a></h3>
280293
<p>The integrated GPU hardware in a Raspberry Pi (“VideoCore”) is rather
281294
idiosyncratic, resulting in a complex set of software options. Probably the
282295
most interesting two options for Raylib applications are:</p>
@@ -298,13 +311,17 @@ <h2>Raspberry Pi<a class="headerlink" href="#raspberry-pi" title="Permalink to t
298311
</ul>
299312
<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>
300313
</div>
314+
</div>
301315
</div>
302316

303317

304318
</div>
305319

306320
</div>
307321
<footer>
322+
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
323+
<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>
324+
</div>
308325

309326
<hr/>
310327

docs/README.html

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -109,6 +109,7 @@
109109
<li class="toctree-l1"><a class="reference internal" href="pyray.html">raylib.pyray</a></li>
110110
<li class="toctree-l1"><a class="reference internal" href="raylib.html">raylib.static</a></li>
111111
<li class="toctree-l1"><a class="reference internal" href="dynamic.html">raylib.dynamic</a></li>
112+
<li class="toctree-l1"><a class="reference internal" href="BUILDING.html">Building from source</a></li>
112113
</ul>
113114

114115

docs/_sources/BUILDING.md.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
# Building from source
2+
13
## Have Pip build from source
24

35
Useful if the binaries don't work on your system.

docs/_sources/index.rst.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@ Raylib Python
1414
pyray
1515
raylib
1616
dynamic
17+
BUILDING
1718

1819

1920
* :ref:`search`

docs/dynamic.html

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,7 @@
4242

4343
<link rel="index" title="Index" href="genindex.html" />
4444
<link rel="search" title="Search" href="search.html" />
45+
<link rel="next" title="Building from source" href="BUILDING.html" />
4546
<link rel="prev" title="raylib.static" href="raylib.html" />
4647
</head>
4748

@@ -100,6 +101,7 @@
100101
<li class="toctree-l1"><a class="reference internal" href="pyray.html">raylib.pyray</a></li>
101102
<li class="toctree-l1"><a class="reference internal" href="raylib.html">raylib.static</a></li>
102103
<li class="toctree-l1 current"><a class="current reference internal" href="#">raylib.dynamic</a></li>
104+
<li class="toctree-l1"><a class="reference internal" href="BUILDING.html">Building from source</a></li>
103105
</ul>
104106

105107

@@ -191,6 +193,7 @@ <h1>raylib.dynamic<a class="headerlink" href="#raylib-dynamic" title="Permalink
191193
</div>
192194
<footer>
193195
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
196+
<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>
194197
<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>
195198
</div>
196199

docs/generated/raylib.pyray.PyRay.html

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -99,6 +99,7 @@
9999
<li class="toctree-l1"><a class="reference internal" href="../pyray.html">raylib.pyray</a></li>
100100
<li class="toctree-l1"><a class="reference internal" href="../raylib.html">raylib.static</a></li>
101101
<li class="toctree-l1"><a class="reference internal" href="../dynamic.html">raylib.dynamic</a></li>
102+
<li class="toctree-l1"><a class="reference internal" href="../BUILDING.html">Building from source</a></li>
102103
</ul>
103104

104105

0 commit comments

Comments
 (0)