From 47c4d0d1b452328a97a837098fa92af2b8a60f25 Mon Sep 17 00:00:00 2001 From: electronstudio Date: Sun, 3 Oct 2021 21:42:57 +0100 Subject: [PATCH] fix docs/name --- docs-src/dynamic.rst | 43 +------------------------------------------ dynamic/README.rst | 42 ++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 43 insertions(+), 42 deletions(-) mode change 100644 => 120000 docs-src/dynamic.rst create mode 100644 dynamic/README.rst diff --git a/docs-src/dynamic.rst b/docs-src/dynamic.rst deleted file mode 100644 index a383645..0000000 --- a/docs-src/dynamic.rst +++ /dev/null @@ -1,42 +0,0 @@ -raylib.dynamic -============== - -CFFI ABI dynamic bindings avoid the need to compile a C extension module. They now been moved to a separate module:: - - python3 -m pip install raylib_dll - -.. warning:: - - There have been some weird failures with dynamic bindings and ctypes bindings before and often the - failures are silent - so you dont even know. Also the static bindings are faster. Therefore I personally recommend the static ones. - But the dynamic bindings have the advantage that you don't need to compile anything to install. You just need a Raylib DLL. - -API is exactly the same as the static one documented here. (Therefore you can't have both modules installed at once.) The only difference is you can't do:: - - from raylib import * - -Instead you have to do:: - - from raylib import raylib as rl - -Then you access the functions with ``rl.`` prefix. See - -See https://github.com/electronstudio/raylib-python-cffi/blob/master/dynamic/test_dynamic.py for an example. - - - -.. important:: - - If your system already has the Raylib library installed, you can set the environment variable ``USE_EXTERNAL_RAYLIB`` and it will - always be used instead of the bundled DLLs. - - - -.. note:: - - If you write a program using the ``rl.`` prefix on all the functions and then you decide you want to use - that same program with the static binding instead of the dynamic, you don't have to remove the ``rl``, - you can just do:: - - import raylib as rl diff --git a/docs-src/dynamic.rst b/docs-src/dynamic.rst new file mode 120000 index 0000000..1ffa1a9 --- /dev/null +++ b/docs-src/dynamic.rst @@ -0,0 +1 @@ +../dynamic/README.rst \ No newline at end of file diff --git a/dynamic/README.rst b/dynamic/README.rst new file mode 100644 index 0000000..9d2e958 --- /dev/null +++ b/dynamic/README.rst @@ -0,0 +1,42 @@ +raylib.dynamic +============== + +CFFI ABI dynamic bindings avoid the need to compile a C extension module. They now been moved to a separate module:: + + python3 -m pip install raylib_dynamic + +.. warning:: + + There have been some weird failures with dynamic bindings and ctypes bindings before and often the + failures are silent + so you dont even know. Also the static bindings are faster. Therefore I personally recommend the static ones. + But the dynamic bindings have the advantage that you don't need to compile anything to install. You just need a Raylib DLL. + +API is exactly the same as the static one documented here. (Therefore you can't have both modules installed at once.) The only difference is you can't do:: + + from raylib import * + +Instead you have to do:: + + from raylib import raylib as rl + +Then you access the functions with ``rl.`` prefix. See + +See https://github.com/electronstudio/raylib-python-cffi/blob/master/dynamic/test_dynamic.py for an example. + + + +.. important:: + + If your system already has the Raylib library installed, you can set the environment variable ``USE_EXTERNAL_RAYLIB`` and it will + always be used instead of the bundled DLLs. + + + +.. note:: + + If you write a program using the ``rl.`` prefix on all the functions and then you decide you want to use + that same program with the static binding instead of the dynamic, you don't have to remove the ``rl``, + you can just do:: + + import raylib as rl