Skip to content

Commit bbcfa14

Browse files
update docs
1 parent b75f690 commit bbcfa14

20 files changed

+55
-18
lines changed
1.44 KB
Binary file not shown.
1.98 KB
Binary file not shown.
15 Bytes
Binary file not shown.

docs-src/_build/html/.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: 2b2f06685939cc687c4ca7d1ce801bbc
3+
config: b194f6bda240fa6b2ce63ebf0c59a33d
44
tags: 645f666f9bcd5a90fca523b33c5a78b7

docs-src/conf.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919
# -- Project information -----------------------------------------------------
2020

2121
project = 'Raylib Python'
22-
copyright = '2022, Richard Smith'
22+
copyright = '2021, Richard Smith'
2323
author = 'Richard Smith'
2424

2525

docs-src/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ Raylib Python
1313
README
1414
pyray
1515
raylib
16+
dynamic
1617

1718

1819
* :ref:`search`

docs/.buildinfo

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

docs/BUILDING.html

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -98,6 +98,7 @@
9898
<li class="toctree-l1"><a class="reference internal" href="README.html#advert">Advert</a></li>
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>
101+
<li class="toctree-l1"><a class="reference internal" href="dynamic.html">raylib.dynamic</a></li>
101102
</ul>
102103

103104

docs/README.html

Lines changed: 19 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,12 @@
9292
<ul class="current">
9393
<li class="toctree-l1 current"><a class="current reference internal" href="#">Python Bindings for Raylib 3.7</a></li>
9494
<li class="toctree-l1"><a class="reference internal" href="#install">Install</a></li>
95-
<li class="toctree-l1"><a class="reference internal" href="#how-to-use">How to use</a></li>
95+
<li class="toctree-l1"><a class="reference internal" href="#how-to-use">How to use</a><ul>
96+
<li class="toctree-l2"><a class="reference internal" href="#if-you-are-familiar-with-c-coding-and-the-raylib-c-library-and-you-want-to-use-an-exact-copy-of-the-c-api">If you are familiar with C coding and the Raylib C library and you want to use an exact copy of the C API</a></li>
97+
<li class="toctree-l2"><a class="reference internal" href="#if-you-prefer-a-slightly-more-pythonistic-api-and-don-t-mind-it-might-be-slightly-slower">If you prefer a slightly more Pythonistic API and don’t mind it might be slightly slower</a></li>
98+
<li class="toctree-l2"><a class="reference internal" href="#if-you-insist-on-dynamic-bindings-and-don-t-care-that-they-are-slower-and-less-safe">If you insist on dynamic bindings and don’t care that they are slower and less safe</a></li>
99+
</ul>
100+
</li>
96101
<li class="toctree-l1"><a class="reference internal" href="#rlzero">RLZero</a></li>
97102
<li class="toctree-l1"><a class="reference internal" href="#help-wanted">Help wanted</a></li>
98103
<li class="toctree-l1"><a class="reference internal" href="#performance">Performance</a><ul>
@@ -103,6 +108,7 @@
103108
<li class="toctree-l1"><a class="reference internal" href="#advert">Advert</a></li>
104109
<li class="toctree-l1"><a class="reference internal" href="pyray.html">raylib.pyray</a></li>
105110
<li class="toctree-l1"><a class="reference internal" href="raylib.html">raylib.static</a></li>
111+
<li class="toctree-l1"><a class="reference internal" href="dynamic.html">raylib.dynamic</a></li>
106112
</ul>
107113

108114

@@ -190,12 +196,18 @@ <h1>Install<a class="headerlink" href="#install" title="Permalink to this headli
190196
<h1>How to use<a class="headerlink" href="#how-to-use" title="Permalink to this headline"></a></h1>
191197
<p>There are three different ways of using this binding. You only need to pick one method, but you
192198
can combine two methods in one program if you want to.</p>
193-
<p>If you are familiar with C coding and the Raylib C library and you want to use an exact copy of
194-
the C API, choose raylib.static.</p>
195-
<p>If you prefer a slightly more Pythonistic API and don’t mind it might be slightly slower, choose
196-
raylib.pyray.</p>
197-
<p>If you insist on dynamic bindings and don’t care that they are slower and less safe, choose
198-
raylib.dynamic.</p>
199+
<div class="section" id="if-you-are-familiar-with-c-coding-and-the-raylib-c-library-and-you-want-to-use-an-exact-copy-of-the-c-api">
200+
<h2>If you are familiar with C coding and the Raylib C library and you want to use an exact copy of the C API<a class="headerlink" href="#if-you-are-familiar-with-c-coding-and-the-raylib-c-library-and-you-want-to-use-an-exact-copy-of-the-c-api" title="Permalink to this headline"></a></h2>
201+
<p>Use <a class="reference external" href="https://electronstudio.github.io/raylib-python-cffi/raylib.html">raylib.static</a>.</p>
202+
</div>
203+
<div class="section" id="if-you-prefer-a-slightly-more-pythonistic-api-and-don-t-mind-it-might-be-slightly-slower">
204+
<h2>If you prefer a slightly more Pythonistic API and don’t mind it might be slightly slower<a class="headerlink" href="#if-you-prefer-a-slightly-more-pythonistic-api-and-don-t-mind-it-might-be-slightly-slower" title="Permalink to this headline"></a></h2>
205+
<p>Use <a class="reference external" href="https://electronstudio.github.io/raylib-python-cffi/pyray.html">raylib.pyray</a>.</p>
206+
</div>
207+
<div class="section" id="if-you-insist-on-dynamic-bindings-and-don-t-care-that-they-are-slower-and-less-safe">
208+
<h2>If you insist on dynamic bindings and don’t care that they are slower and less safe<a class="headerlink" href="#if-you-insist-on-dynamic-bindings-and-don-t-care-that-they-are-slower-and-less-safe" title="Permalink to this headline"></a></h2>
209+
<p>Use <a class="reference external" href="https://electronstudio.github.io/raylib-python-cffi/dynamic.html">raylib.dynamic</a>.</p>
210+
</div>
199211
</div>
200212
<div class="tex2jax_ignore mathjax_ignore section" id="rlzero">
201213
<h1>RLZero<a class="headerlink" href="#rlzero" title="Permalink to this headline"></a></h1>

docs/_sources/README.md.txt

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -24,14 +24,17 @@ If yours isn't available then pip will attempt to build from source, so you will
2424
There are three different ways of using this binding. You only need to pick one method, but you
2525
can combine two methods in one program if you want to.
2626

27-
If you are familiar with C coding and the Raylib C library and you want to use an exact copy of
28-
the C API, choose raylib.static.
27+
### If you are familiar with C coding and the Raylib C library and you want to use an exact copy of the C API
2928

30-
If you prefer a slightly more Pythonistic API and don't mind it might be slightly slower, choose
31-
raylib.pyray.
29+
Use [raylib.static](https://electronstudio.github.io/raylib-python-cffi/raylib.html).
3230

33-
If you insist on dynamic bindings and don't care that they are slower and less safe, choose
34-
raylib.dynamic.
31+
### If you prefer a slightly more Pythonistic API and don't mind it might be slightly slower
32+
33+
Use [raylib.pyray](https://electronstudio.github.io/raylib-python-cffi/pyray.html).
34+
35+
### If you insist on dynamic bindings and don't care that they are slower and less safe
36+
37+
Use [raylib.dynamic](https://electronstudio.github.io/raylib-python-cffi/dynamic.html).
3538

3639

3740

0 commit comments

Comments
 (0)