indocumentationexamplessetup

Joris Gillis edited this page May 10, 2011 · 4 revisions

The framework to generate the output (PDF and log) for the in-documentation-examples is not platform independent. It probably only works in linux-flavoured systems. This is considered acceptable since regular users should not generate that output; they can just consult the online-documentation.

Prerequisites C++

You need to build CasADi with the WITH_DOC flag on.

This will compile a dummy file that depends on every CasADi feature. The CMake generated linker and include flags will be harvested by /documentation/examples/ctemplate/ctemplate.py

The CMake framework is not used the in-documentation-examples themselves. Rather pure make and shell-scripts carry out the magic to lower the maintenance burden.

Prerequisites Python

You need to have installed pyreport easy_install pyreport and docutils sudo apt-get install python-docutils

Setup

If you have your builddir in /build, then it's easy: just issue a make in /documentation/examples. This requires that WITH_DOC flag was on when building.

Clone this wiki locally
You can’t perform that action at this time.
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.
Press h to open a hovercard with more details.