Skip to content

Commit a98e0be

Browse files
electronstudioelectronstudio
committed
docs update
1 parent 4b3f443 commit a98e0be

File tree

16 files changed

+1517
-2570
lines changed

16 files changed

+1517
-2570
lines changed

‎docs/.buildinfo‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
# Sphinx build info version 1
22
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
3-
config: b194f6bda240fa6b2ce63ebf0c59a33d
3+
config: cc130bfc0dc4a1401fdcd32a4066bb28
44
tags: 645f666f9bcd5a90fca523b33c5a78b7

‎docs/BUILDING.html‎

Lines changed: 25 additions & 133 deletions
Original file line numberDiff line numberDiff line change
@@ -1,96 +1,46 @@
1-
2-
31
<!DOCTYPE html>
42
<html class="writer-html5" lang="en" >
53
<head>
64
<meta charset="utf-8" />
7-
85
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
9-
106
<title>Building from source &mdash; Raylib Python documentation</title>
11-
12-
13-
14-
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
15-
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
16-
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
17-
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
18-
<link rel="stylesheet" href="_static/graphviz.css" type="text/css" />
19-
20-
21-
22-
23-
24-
25-
26-
27-
28-
7+
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
8+
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
9+
<link rel="stylesheet" href="_static/graphviz.css" type="text/css" />
2910
<!--[if lt IE 9]>
3011
<script src="_static/js/html5shiv.min.js"></script>
3112
<![endif]-->
3213

33-
34-
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
3514
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
3615
<script src="_static/jquery.js"></script>
3716
<script src="_static/underscore.js"></script>
3817
<script src="_static/doctools.js"></script>
39-
40-
<script type="text/javascript" src="_static/js/theme.js"></script>
41-
42-
18+
<script src="_static/js/theme.js"></script>
4319
<link rel="index" title="Index" href="genindex.html" />
4420
<link rel="search" title="Search" href="search.html" />
4521
<link rel="prev" title="raylib.dynamic" href="dynamic.html" />
4622
</head>
4723

48-
<body class="wy-body-for-nav">
49-
50-
24+
<body class="wy-body-for-nav">
5125
<div class="wy-grid-for-nav">
52-
5326
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
5427
<div class="wy-side-scroll">
5528
<div class="wy-side-nav-search" >
56-
57-
58-
5929
<a href="index.html" class="icon icon-home"> Raylib Python
60-
61-
62-
6330
</a>
64-
65-
66-
67-
68-
69-
70-
7131
<div role="search">
7232
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
7333
<input type="text" name="q" placeholder="Search docs" />
7434
<input type="hidden" name="check_keywords" value="yes" />
7535
<input type="hidden" name="area" value="default" />
7636
</form>
7737
</div>
78-
79-
80-
</div>
81-
82-
83-
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
84-
85-
86-
87-
88-
89-
38+
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
9039
<p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
9140
<ul class="current">
9241
<li class="toctree-l1"><a class="reference internal" href="README.html">Python Bindings for Raylib 3.7</a></li>
93-
<li class="toctree-l1"><a class="reference internal" href="README.html#install">Install</a></li>
42+
<li class="toctree-l1"><a class="reference internal" href="README.html#license-updated">License (updated)</a></li>
43+
<li class="toctree-l1"><a class="reference internal" href="README.html#installation">Installation</a></li>
9444
<li class="toctree-l1"><a class="reference internal" href="README.html#how-to-use">How to use</a></li>
9545
<li class="toctree-l1"><a class="reference internal" href="README.html#rlzero">RLZero</a></li>
9646
<li class="toctree-l1"><a class="reference internal" href="README.html#help-wanted">Help wanted</a></li>
@@ -112,89 +62,48 @@
11262
</li>
11363
</ul>
11464

115-
116-
11765
</div>
118-
11966
</div>
12067
</nav>
12168

122-
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
123-
124-
125-
<nav class="wy-nav-top" aria-label="top navigation">
126-
69+
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
12770
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
12871
<a href="index.html">Raylib Python</a>
129-
13072
</nav>
13173

132-
13374
<div class="wy-nav-content">
134-
13575
<div class="rst-content">
136-
137-
138-
139-
140-
141-
142-
143-
144-
145-
146-
147-
148-
149-
150-
151-
152-
153-
154-
155-
<div role="navigation" aria-label="breadcrumbs navigation">
156-
76+
<div role="navigation" aria-label="Page navigation">
15777
<ul class="wy-breadcrumbs">
158-
15978
<li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
160-
16179
<li>Building from source</li>
162-
163-
16480
<li class="wy-breadcrumbs-aside">
165-
166-
16781
<a href="_sources/BUILDING.md.txt" rel="nofollow"> View page source</a>
168-
169-
17082
</li>
171-
17283
</ul>
173-
174-
17584
<hr/>
17685
</div>
17786
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
17887
<div itemprop="articleBody">
179-
88+
18089
<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>
90+
<h1>Building from source<a class="headerlink" href="#building-from-source" title="Permalink to this headline"></a></h1>
18291
<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>
92+
<h2>Have Pip build from source<a class="headerlink" href="#have-pip-build-from-source" title="Permalink to this headline"></a></h2>
18493
<p>Useful if the binaries don’t work on your system.</p>
18594
<p>Make sure Raylib is installed and then:</p>
18695
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>pip3 install --no-binary raylib --upgrade --force-reinstall raylib
18796
</pre></div>
18897
</div>
18998
</div>
19099
<div class="section" id="build-from-source-manually">
191-
<h2>Build from source manually<a class="headerlink" href="#build-from-source-manually" title="Permalink to this headline"></a></h2>
100+
<h2>Build from source manually<a class="headerlink" href="#build-from-source-manually" title="Permalink to this headline"></a></h2>
192101
<p>Useful if the Pip build doesn’t work, or you want to contribute to the project, or you want to skip building the
193102
static lib and just <em>use the dynamic binding with your own dll</em>.</p>
194103
<p>If you do build on a new platform please
195104
submit your binaries as a PR.</p>
196105
<div class="section" id="windows-manual-build">
197-
<h3>Windows manual build<a class="headerlink" href="#windows-manual-build" title="Permalink to this headline"></a></h3>
106+
<h3>Windows manual build<a class="headerlink" href="#windows-manual-build" title="Permalink to this headline"></a></h3>
198107
<p>Clone this repo including submodules so you get correct version of Raylib.</p>
199108
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>git clone --recurse-submodules https://github.com/electronstudio/raylib-python-cffi
200109
</pre></div>
@@ -235,7 +144,7 @@ <h3>Windows manual build<a class="headerlink" href="#windows-manual-build" title
235144
<p>(Note: your wheel’s filename will probably be different than the one here.)</p>
236145
</div>
237146
<div class="section" id="linux-etc-manual-build">
238-
<h3>Linux etc manual build<a class="headerlink" href="#linux-etc-manual-build" title="Permalink to this headline"></a></h3>
147+
<h3>Linux etc manual build<a class="headerlink" href="#linux-etc-manual-build" title="Permalink to this headline"></a></h3>
239148
<p>These instructions have been tested on Ubuntu 20.10 and 16.04. Mac should be very similar.</p>
240149
<p>Clone this repo including submodules so you get correct version of Raylib.</p>
241150
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>git clone --recurse-submodules https://github.com/electronstudio/raylib-python-cffi
@@ -297,7 +206,7 @@ <h3>Linux etc manual build<a class="headerlink" href="#linux-etc-manual-build" t
297206
<p>(TODO move the dynamic libs into a separate package rather than include them with every one.)</p>
298207
</div>
299208
<div class="section" id="raspberry-pi">
300-
<h3>Raspberry Pi<a class="headerlink" href="#raspberry-pi" title="Permalink to this headline"></a></h3>
209+
<h3>Raspberry Pi<a class="headerlink" href="#raspberry-pi" title="Permalink to this headline"></a></h3>
301210
<p>The integrated GPU hardware in a Raspberry Pi (“VideoCore”) is rather
302211
idiosyncratic, resulting in a complex set of software options. Probably the
303212
most interesting two options for Raylib applications are:</p>
@@ -324,49 +233,32 @@ <h3>Raspberry Pi<a class="headerlink" href="#raspberry-pi" title="Permalink to t
324233

325234

326235
</div>
327-
328236
</div>
329-
<footer>
330-
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
237+
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
331238
<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>
332239
</div>
333240

334241
<hr/>
335242

336243
<div role="contentinfo">
337-
<p>
338-
&#169; Copyright 2021, Richard Smith.
339-
340-
</p>
244+
<p>&#169; Copyright 2021, Richard Smith.</p>
341245
</div>
342-
343-
344-
345-
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
346-
246+
247+
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
347248
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
348-
349-
provided by <a href="https://readthedocs.org">Read the Docs</a>.
249+
provided by <a href="https://readthedocs.org">Read the Docs</a>.
250+
350251

351252
</footer>
352253
</div>
353254
</div>
354-
355255
</section>
356-
357256
</div>
358-
359-
360-
<script type="text/javascript">
257+
<script>
361258
jQuery(function () {
362259
SphinxRtdTheme.Navigation.enable(true);
363260
});
364-
</script>
365-
366-
367-
368-
369-
261+
</script>
370262

371263
</body>
372264
</html>

0 commit comments

Comments
 (0)