diff --git a/python/README.md b/docs/python-bindings.md similarity index 93% rename from python/README.md rename to docs/python-bindings.md index a65dcbd64..b9527c095 100644 --- a/python/README.md +++ b/docs/python-bindings.md @@ -1,12 +1,11 @@ # Python wrappers for libigl - ## Work in progress - -Everything in this folder is currently being developed and it is likely to be -changed radically in the next couple of months, breaking compatibility between -different version. We plan to stabilize the python API by the end of 2016. - + +!!! warning + Everything in this folder is currently being developed and it is likely to be + changed radically in the next couple of months, breaking compatibility between + different version. We plan to stabilize the python API by the end of 2016. ## Introduction @@ -67,8 +66,8 @@ python 102_DrawMesh.py ## Matrix Representation -TODO: describe in detail the wrapped eigen classes and how to convert them to -numpy. +!!! todo + describe in detail the wrapped eigen classes and how to convert them to numpy. ## Viewer and callbacks @@ -162,6 +161,7 @@ If you find bugs or have problems please use our [github issue tracking page](https://github.com/libigl/libigl/issues). ## Copyright + 2015 Alec Jacobson, Daniele Panozzo, Christian Schüller, Olga Diamanti, Qingnan Zhou, Sebastian Koch, Nico Pietroni, Stefan Brugger, Kenshi Takayama, Wenzel Jakob, Nikolas De Giorgis, Luigi Rocca, Leonardo Sacht, Olga Sorkine-Hornung, and others. diff --git a/mkdocs.yml b/mkdocs.yml index 7eb72ecba..6eb32d0e1 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -58,8 +58,9 @@ pages: - "Chapter 8: Outlook for continuing development": tutorial/chapter-8.md - Compilation: - Example Project: example-project.md - - Static Library: static-library.md + # - Static Library: static-library.md - External Dependencies: third-party.md + - Python Bindings: python-bindings.md - Contributing: - Style Guidelines: style-guidelines.md - Bug Report: CONTRIBUTING.md