Helper tool for documenting scripts in the Wiki

Info about new community or project announcements, implemented features, classes, modules or APIs. Might get technical!
PLEASE DO NOT POST HELP REQUESTS OR OTHER DISCUSSIONS HERE!
Forum rules
Be nice to others! Respect the FreeCAD code of conduct!
Post Reply
User avatar
jriegel
Founder
Posts: 3369
Joined: Sun Feb 15, 2009 5:29 pm
Location: Ulm, Germany
Contact:

Helper tool for documenting scripts in the Wiki

Post by jriegel »

I have added a small script which format a Example python script for FreeCAD in the wiki way.

The script is located here:
http://free-cad.svn.sourceforge.net/vie ... iew=markup

And as an example I have used it to convert the drawing scripting example file:
http://free-cad.svn.sourceforge.net/vie ... iew=markup

to the docu:
https://sourceforge.net/apps/mediawiki/ ... #Scripting

The script makes mainly the indetion for code blocks and make python comments with a following space to
a normal wiki text....

That will help us to keep scripting docu and the Wiki more in sync.
I intend to make such example pages for all major components...
The examples will be part of the SVN repositories.
Help appreciated ;)

Cheers Jürgen
Stop whining - start coding!
Post Reply