From 938b551f07bcd795c78acd16ae279941a9e3a6f7 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Vladim=C3=ADr=20Vondru=C5=A1?= Date: Mon, 10 Apr 2023 12:22:41 +0200 Subject: [PATCH] python: further improve developer guide for adding new libraries. --- doc/python/pages/developers.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/doc/python/pages/developers.rst b/doc/python/pages/developers.rst index 1e33f9b..c75f212 100644 --- a/doc/python/pages/developers.rst +++ b/doc/python/pages/developers.rst @@ -50,7 +50,7 @@ Developers Guide module from ``magnum_foo_SRCS``, linking to ``Magnum::Foo`` and setting ``OUTPUT_NAME`` to ``foo``. 3. Add a :cmake:`if(Magnum_Foo_FOUND)` branch to the :cmake:`else()` - condition, ``APPEND``\ ing ``magnum_FOO_SRCS`` to ``magnum_SRCS`` and + condition, ``APPEND``\ ing ``magnum_foo_SRCS`` to ``magnum_SRCS`` and ``Magnum::Foo`` to ``magnum_LIBS``. 4. Add :cpp:`void foo(py::module_& m);` forward declaration to ``magnum/bootstrap.h``, and :cpp:`#cmakdefeine Magnum_Foo_FOUND` to @@ -62,7 +62,7 @@ Developers Guide :cpp:`#ifdef MAGNUM_BUILD_STATIC` section of :cpp:`PYBIND11_MODULE()` in ``magnum/magnum.cpp``. 7. Add the new module name to the list in ``magnum/__init__.py``. -8. Add a line with `magnum_foo` to the :cmake:`foreach()` in +8. Add a line with ``magnum_foo`` to the :cmake:`foreach()` in ``src/python/CMakeLists.txt``, and then a corresponding :py:`'magnum.foo'` entry in ``src/python/setup.py.cmake`` 9. Add a ``magnum/test/test_foo.py`` test file, and potentially also