Freestyle integration into Blender

April 18, 2010

Weekly update April 5-18

Filed under: Update — The dev team @ 8:32 PM

Over the last two weeks, the dev team was intensively working on major updates of the Freestyle Python API documentation.  The idea was to incorporate the contents of the original Freestyle API reference manual into the Blender/Freestyle Python API implementation in the form of Sphinx-based docstrings (i.e., pieces of API descriptions in string literals).  This way the dev team can take the advantages of the new Blender 2.5 documentation system that allows us 1) to keep the API implementation and documentation in sync by having docstrings within the source code, and 2) to generate an up-to-date and nicely formatted API reference manual through the fully automated Blender 2.5 documentation tools.  Not only we imported the contents of the original Freestyle API reference manual and reformatted them with Sphinx mark-ups, but also we made a substantial revision of the text by filling missing entries, elaborating sparse descriptions, and making C++-oriented descriptions more suitable for Python programmers.

For those who are interested in how the new Freestyle Python API reference looks like, here is a screenshot (click it to enlarge):

Branch users can generate the API reference themselves by following the instructions shown in the Web page of the documentation tools.  Note that generating the formatted API documentation is not part of the usual build process.  You need to start the documentation generation separately after you have built a Blender executable file.

The next target is to finish the Python API improvements (finally).  The documentation updates were indeed a nice opportunity to go through the current API implementation with a fresh mind, and we identified some remaining API design and implementation issues.  We are going to address them in the next weeks.  The work on the API improvements will also be accompanied with further documentation updates in line with any changes in the API implementation.  All standard style modules are accordingly updated as well.



  1. Excellent addition, congrats! I can’t wait the new 2.50 api to become stable to use all this together. Keep up the good work!

    Comment by Yorik — April 19, 2010 @ 12:42 AM

  2. Documentation is a good thing! Keep up the good work!

    Comment by Marcus — April 19, 2010 @ 10:24 AM

  3. Any updates on progress?

    Comment by Barts — May 11, 2010 @ 8:58 AM

  4. Barts, I just posted an update. Thanks for your interest on the branch.

    Comment by The dev team — May 12, 2010 @ 12:43 AM

RSS feed for comments on this post. TrackBack URI

Leave a Reply

Fill in your details below or click an icon to log in: Logo

You are commenting using your account. Log Out /  Change )

Google+ photo

You are commenting using your Google+ account. Log Out /  Change )

Twitter picture

You are commenting using your Twitter account. Log Out /  Change )

Facebook photo

You are commenting using your Facebook account. Log Out /  Change )


Connecting to %s

Blog at

%d bloggers like this: