update docs
This commit is contained in:
parent
b75f690e2d
commit
bbcfa14159
20 changed files with 55 additions and 18 deletions
Binary file not shown.
Binary file not shown.
Binary file not shown.
|
@ -1,4 +1,4 @@
|
||||||
# Sphinx build info version 1
|
# Sphinx build info version 1
|
||||||
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
|
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
|
||||||
config: 2b2f06685939cc687c4ca7d1ce801bbc
|
config: b194f6bda240fa6b2ce63ebf0c59a33d
|
||||||
tags: 645f666f9bcd5a90fca523b33c5a78b7
|
tags: 645f666f9bcd5a90fca523b33c5a78b7
|
||||||
|
|
|
@ -19,7 +19,7 @@ sys.path.insert(0, os.path.abspath('../'))
|
||||||
# -- Project information -----------------------------------------------------
|
# -- Project information -----------------------------------------------------
|
||||||
|
|
||||||
project = 'Raylib Python'
|
project = 'Raylib Python'
|
||||||
copyright = '2022, Richard Smith'
|
copyright = '2021, Richard Smith'
|
||||||
author = 'Richard Smith'
|
author = 'Richard Smith'
|
||||||
|
|
||||||
|
|
||||||
|
|
|
@ -13,6 +13,7 @@ Raylib Python
|
||||||
README
|
README
|
||||||
pyray
|
pyray
|
||||||
raylib
|
raylib
|
||||||
|
dynamic
|
||||||
|
|
||||||
|
|
||||||
* :ref:`search`
|
* :ref:`search`
|
||||||
|
|
4
docs/.buildinfo
Normal file
4
docs/.buildinfo
Normal file
|
@ -0,0 +1,4 @@
|
||||||
|
# Sphinx build info version 1
|
||||||
|
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
|
||||||
|
config: b194f6bda240fa6b2ce63ebf0c59a33d
|
||||||
|
tags: 645f666f9bcd5a90fca523b33c5a78b7
|
|
@ -98,6 +98,7 @@
|
||||||
<li class="toctree-l1"><a class="reference internal" href="README.html#advert">Advert</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="README.html#advert">Advert</a></li>
|
||||||
<li class="toctree-l1"><a class="reference internal" href="pyray.html">raylib.pyray</a></li>
|
<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="raylib.html">raylib.static</a></li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="dynamic.html">raylib.dynamic</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
|
@ -92,7 +92,12 @@
|
||||||
<ul class="current">
|
<ul class="current">
|
||||||
<li class="toctree-l1 current"><a class="current reference internal" href="#">Python Bindings for Raylib 3.7</a></li>
|
<li class="toctree-l1 current"><a class="current reference internal" href="#">Python Bindings for Raylib 3.7</a></li>
|
||||||
<li class="toctree-l1"><a class="reference internal" href="#install">Install</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="#install">Install</a></li>
|
||||||
<li class="toctree-l1"><a class="reference internal" href="#how-to-use">How to use</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="#how-to-use">How to use</a><ul>
|
||||||
|
<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>
|
||||||
|
<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>
|
||||||
|
<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>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
<li class="toctree-l1"><a class="reference internal" href="#rlzero">RLZero</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="#rlzero">RLZero</a></li>
|
||||||
<li class="toctree-l1"><a class="reference internal" href="#help-wanted">Help wanted</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="#help-wanted">Help wanted</a></li>
|
||||||
<li class="toctree-l1"><a class="reference internal" href="#performance">Performance</a><ul>
|
<li class="toctree-l1"><a class="reference internal" href="#performance">Performance</a><ul>
|
||||||
|
@ -103,6 +108,7 @@
|
||||||
<li class="toctree-l1"><a class="reference internal" href="#advert">Advert</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="#advert">Advert</a></li>
|
||||||
<li class="toctree-l1"><a class="reference internal" href="pyray.html">raylib.pyray</a></li>
|
<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="raylib.html">raylib.static</a></li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="dynamic.html">raylib.dynamic</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
@ -190,12 +196,18 @@ original Raylib. Faster, fewer bugs and easier to maintain than ctypes.</p>
|
||||||
<h1>How to use<a class="headerlink" href="#how-to-use" title="Permalink to this headline">¶</a></h1>
|
<h1>How to use<a class="headerlink" href="#how-to-use" title="Permalink to this headline">¶</a></h1>
|
||||||
<p>There are three different ways of using this binding. You only need to pick one method, but you
|
<p>There are three different ways of using this binding. You only need to pick one method, but you
|
||||||
can combine two methods in one program if you want to.</p>
|
can combine two methods in one program if you want to.</p>
|
||||||
<p>If you are familiar with C coding and the Raylib C library and you want to use an exact copy of
|
<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">
|
||||||
the C API, choose raylib.static.</p>
|
<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>
|
||||||
<p>If you prefer a slightly more Pythonistic API and don’t mind it might be slightly slower, choose
|
<p>Use <a class="reference external" href="https://electronstudio.github.io/raylib-python-cffi/raylib.html">raylib.static</a>.</p>
|
||||||
raylib.pyray.</p>
|
</div>
|
||||||
<p>If you insist on dynamic bindings and don’t care that they are slower and less safe, choose
|
<div class="section" id="if-you-prefer-a-slightly-more-pythonistic-api-and-don-t-mind-it-might-be-slightly-slower">
|
||||||
raylib.dynamic.</p>
|
<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>
|
||||||
|
<p>Use <a class="reference external" href="https://electronstudio.github.io/raylib-python-cffi/pyray.html">raylib.pyray</a>.</p>
|
||||||
|
</div>
|
||||||
|
<div class="section" id="if-you-insist-on-dynamic-bindings-and-don-t-care-that-they-are-slower-and-less-safe">
|
||||||
|
<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>
|
||||||
|
<p>Use <a class="reference external" href="https://electronstudio.github.io/raylib-python-cffi/dynamic.html">raylib.dynamic</a>.</p>
|
||||||
|
</div>
|
||||||
</div>
|
</div>
|
||||||
<div class="tex2jax_ignore mathjax_ignore section" id="rlzero">
|
<div class="tex2jax_ignore mathjax_ignore section" id="rlzero">
|
||||||
<h1>RLZero<a class="headerlink" href="#rlzero" title="Permalink to this headline">¶</a></h1>
|
<h1>RLZero<a class="headerlink" href="#rlzero" title="Permalink to this headline">¶</a></h1>
|
||||||
|
|
|
@ -24,14 +24,17 @@ If yours isn't available then pip will attempt to build from source, so you will
|
||||||
There are three different ways of using this binding. You only need to pick one method, but you
|
There are three different ways of using this binding. You only need to pick one method, but you
|
||||||
can combine two methods in one program if you want to.
|
can combine two methods in one program if you want to.
|
||||||
|
|
||||||
If you are familiar with C coding and the Raylib C library and you want to use an exact copy of
|
### If you are familiar with C coding and the Raylib C library and you want to use an exact copy of the C API
|
||||||
the C API, choose raylib.static.
|
|
||||||
|
|
||||||
If you prefer a slightly more Pythonistic API and don't mind it might be slightly slower, choose
|
Use [raylib.static](https://electronstudio.github.io/raylib-python-cffi/raylib.html).
|
||||||
raylib.pyray.
|
|
||||||
|
|
||||||
If you insist on dynamic bindings and don't care that they are slower and less safe, choose
|
### If you prefer a slightly more Pythonistic API and don't mind it might be slightly slower
|
||||||
raylib.dynamic.
|
|
||||||
|
Use [raylib.pyray](https://electronstudio.github.io/raylib-python-cffi/pyray.html).
|
||||||
|
|
||||||
|
### If you insist on dynamic bindings and don't care that they are slower and less safe
|
||||||
|
|
||||||
|
Use [raylib.dynamic](https://electronstudio.github.io/raylib-python-cffi/dynamic.html).
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
|
@ -13,6 +13,7 @@ Raylib Python
|
||||||
README
|
README
|
||||||
pyray
|
pyray
|
||||||
raylib
|
raylib
|
||||||
|
dynamic
|
||||||
|
|
||||||
|
|
||||||
* :ref:`search`
|
* :ref:`search`
|
||||||
|
|
|
@ -42,6 +42,7 @@
|
||||||
|
|
||||||
<link rel="index" title="Index" href="genindex.html" />
|
<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.static" href="raylib.html" />
|
||||||
</head>
|
</head>
|
||||||
|
|
||||||
<body class="wy-body-for-nav">
|
<body class="wy-body-for-nav">
|
||||||
|
@ -87,7 +88,7 @@
|
||||||
|
|
||||||
|
|
||||||
<p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
|
<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">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#install">Install</a></li>
|
||||||
<li class="toctree-l1"><a class="reference internal" href="README.html#how-to-use">How to use</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="README.html#how-to-use">How to use</a></li>
|
||||||
|
@ -98,6 +99,7 @@
|
||||||
<li class="toctree-l1"><a class="reference internal" href="README.html#advert">Advert</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="README.html#advert">Advert</a></li>
|
||||||
<li class="toctree-l1"><a class="reference internal" href="pyray.html">raylib.pyray</a></li>
|
<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="raylib.html">raylib.static</a></li>
|
||||||
|
<li class="toctree-l1 current"><a class="current reference internal" href="#">raylib.dynamic</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
@ -188,6 +190,9 @@ But the dynamic bindings have the big advantage that you don’t need to compile
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
<footer>
|
<footer>
|
||||||
|
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
|
||||||
|
<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>
|
||||||
|
|
||||||
<hr/>
|
<hr/>
|
||||||
|
|
||||||
|
|
|
@ -98,6 +98,7 @@
|
||||||
<li class="toctree-l1"><a class="reference internal" href="../README.html#advert">Advert</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="../README.html#advert">Advert</a></li>
|
||||||
<li class="toctree-l1"><a class="reference internal" href="../pyray.html">raylib.pyray</a></li>
|
<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="../raylib.html">raylib.static</a></li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../dynamic.html">raylib.dynamic</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
|
@ -98,6 +98,7 @@
|
||||||
<li class="toctree-l1"><a class="reference internal" href="README.html#advert">Advert</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="README.html#advert">Advert</a></li>
|
||||||
<li class="toctree-l1"><a class="reference internal" href="pyray.html">raylib.pyray</a></li>
|
<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="raylib.html">raylib.static</a></li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="dynamic.html">raylib.dynamic</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
|
@ -99,6 +99,7 @@
|
||||||
<li class="toctree-l1"><a class="reference internal" href="README.html#advert">Advert</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="README.html#advert">Advert</a></li>
|
||||||
<li class="toctree-l1"><a class="reference internal" href="pyray.html">raylib.pyray</a></li>
|
<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="raylib.html">raylib.static</a></li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="dynamic.html">raylib.dynamic</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
@ -181,6 +182,7 @@
|
||||||
<li class="toctree-l1"><a class="reference internal" href="README.html#advert">Advert</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="README.html#advert">Advert</a></li>
|
||||||
<li class="toctree-l1"><a class="reference internal" href="pyray.html">raylib.pyray</a></li>
|
<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="raylib.html">raylib.static</a></li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="dynamic.html">raylib.dynamic</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</div>
|
</div>
|
||||||
<ul class="simple">
|
<ul class="simple">
|
||||||
|
|
|
@ -101,6 +101,7 @@
|
||||||
<li class="toctree-l1"><a class="reference internal" href="README.html#advert">Advert</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="README.html#advert">Advert</a></li>
|
||||||
<li class="toctree-l1"><a class="reference internal" href="pyray.html">raylib.pyray</a></li>
|
<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="raylib.html">raylib.static</a></li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="dynamic.html">raylib.dynamic</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
|
@ -916,6 +916,7 @@
|
||||||
</ul>
|
</ul>
|
||||||
</li>
|
</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="raylib.html">raylib.static</a></li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="dynamic.html">raylib.dynamic</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
|
@ -42,6 +42,7 @@
|
||||||
|
|
||||||
<link rel="index" title="Index" href="genindex.html" />
|
<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="next" title="raylib.dynamic" href="dynamic.html" />
|
||||||
<link rel="prev" title="raylib.pyray" href="pyray.html" />
|
<link rel="prev" title="raylib.pyray" href="pyray.html" />
|
||||||
</head>
|
</head>
|
||||||
|
|
||||||
|
@ -566,6 +567,7 @@
|
||||||
</li>
|
</li>
|
||||||
</ul>
|
</ul>
|
||||||
</li>
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="dynamic.html">raylib.dynamic</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
@ -3907,6 +3909,7 @@ are very, very similar to the C originals.</p>
|
||||||
</div>
|
</div>
|
||||||
<footer>
|
<footer>
|
||||||
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
|
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
|
||||||
|
<a href="dynamic.html" class="btn btn-neutral float-right" title="raylib.dynamic" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
||||||
<a href="pyray.html" class="btn btn-neutral float-left" title="raylib.pyray" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
<a href="pyray.html" class="btn btn-neutral float-left" title="raylib.pyray" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
|
|
|
@ -101,6 +101,7 @@
|
||||||
<li class="toctree-l1"><a class="reference internal" href="README.html#advert">Advert</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="README.html#advert">Advert</a></li>
|
||||||
<li class="toctree-l1"><a class="reference internal" href="pyray.html">raylib.pyray</a></li>
|
<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="raylib.html">raylib.static</a></li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="dynamic.html">raylib.dynamic</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
File diff suppressed because one or more lines are too long
Reference in a new issue