Browse Source

doc: python bindings are in master now.

pull/2/head
Vladimír Vondruš 7 years ago
parent
commit
f6136c8895
  1. 7
      doc/python/conf.py
  2. 15
      doc/python/pages/building.rst

7
doc/python/conf.py

@ -101,10 +101,9 @@ PAGE_HEADER = """
Welcome to the exciting new Python-flavored future of Magnum! Have fun, but Welcome to the exciting new Python-flavored future of Magnum! Have fun, but
please note this functionality is *heavily experimental* at the moment. please note this functionality is *heavily experimental* at the moment.
Most APIs are missing, documentation is very sparse and Most APIs are missing, documentation is very sparse and everything is still
:gh:`everything is still evolving <mosra/magnum-bindings#1>`. evolving. **Use at your own risk.** Search and name cross-linking is not
**Use at your own risk.** Search and name cross-linking is not working yet, working yet, sorry about that.
sorry about that.
""" """
FINE_PRINT = """ FINE_PRINT = """

15
doc/python/pages/building.rst

@ -59,12 +59,6 @@ the source tree.
cd package/archlinux cd package/archlinux
makepkg -fp PKGBUILD makepkg -fp PKGBUILD
.. block-warning:: Subject to change
The bindings are not in ``master`` yet (:gh:`mosra/magnum-bindings#1`), use
:sh:`git checkout python` or pass ``--branch python`` to :sh:`git clone` at
the moment.
The PKGBUILD also contains a :sh:`check()` function which will run all unit The PKGBUILD also contains a :sh:`check()` function which will run all unit
tests before packaging. That might sometimes fail or take too long, pass tests before packaging. That might sometimes fail or take too long, pass
``--nocheck`` to ``makepkg`` to skip that. ``--nocheck`` to ``makepkg`` to skip that.
@ -86,12 +80,6 @@ snapshot as a compressed archive or use the command line:
git clone git://github.com/mosra/magnum-bindings.git git clone git://github.com/mosra/magnum-bindings.git
.. block-warning:: Subject to change
The bindings are not in ``master`` yet (:gh:`mosra/magnum-bindings#1`), use
:sh:`git checkout python` or pass ``--branch python`` to :sh:`git clone` at
the moment.
Assuming a Unix-based OS, the first step is to build the native libraries. The Assuming a Unix-based OS, the first step is to build the native libraries. The
bindings will be generated for all Corrade and Magnum libraries that are found, bindings will be generated for all Corrade and Magnum libraries that are found,
ignoring the ones which aren't. If Corrade, Magnum and pybind11 are not in a ignoring the ones which aren't. If Corrade, Magnum and pybind11 are not in a
@ -162,5 +150,6 @@ following commands, the resulting HTML overview is located in
In ``package/ci/`` there is a ``travis.yml`` file that compiles and tests the In ``package/ci/`` there is a ``travis.yml`` file that compiles and tests the
bindings on Linux GCC 4.8 + CMake 3.1 and on macOS. Online at bindings on Linux GCC 4.8 + CMake 3.1 and on macOS. Online at
https://travis-ci.org/mosra/magnum-bindings, code coverage is reported to https://travis-ci.org/mosra/magnum-bindings. Code coverage for both the C++
bindings code and Python side is reported to
https://codecov.io/gh/mosra/magnum-bindings. https://codecov.io/gh/mosra/magnum-bindings.

Loading…
Cancel
Save