Generate RoboFab Documentation

71 views
Skip to first unread message

Kannery Bosch

unread,
Nov 27, 2013, 4:59:09 AM11/27/13
to rob...@googlegroups.com

There is a script that comes with RoboFab called makeDocumentation.py -->

This script will generate up to date documentation for RoboFab. This script will make a bunch of HTML files in robofab/Documentation/robofabDoc/ 
It collects all docstrings, shows classes, methods and functions. This script uses pydoc. The results of this script depend on the environment you run it in.

I would love to use this with Frederik's RoboFont to generate the RoboFont related documentation. But how? Does the script need to be modified?

There seems to be some FontLab specific code in the makeDocumentation.py script, this I am not interested in, can it be changed to RoboFont specific -->

# this is a list of FontLab specific modules that need to be documented
import robofab.objects.objectsFL
import robofab.tools.toolsFL
import robofab.pens.flPen
import robofab.tools.otFeatures


Thanks for any tips about generating documentation for RoboFont!

-Kannery

Mathieu Christe

unread,
Nov 27, 2013, 5:14:09 AM11/27/13
to rob...@googlegroups.com
Hi Kannery,

Just in case you're looking for a RoboFont documentation:

For the coding part, I won't be very helpful unfortunately.

Good luck,

Mathieu

Frederik Berlaen

unread,
Nov 27, 2013, 5:40:52 AM11/27/13
to rob...@googlegroups.com
Hi

thanks Mathieu, 
to be more specific all additional roboFab APIs can be found here http://doc.robofont.com/api/robofab-extras/

good luck!

gr Frederik



--
--
You received this message because you are subscribed to the Google Groups "RoboFab" group.
To post to this group, send email to rob...@googlegroups.com
To unsubscribe from this group, send email to robofab-u...@googlegroups.com
For more options, visit this group at http://groups.google.com/group/robofab?hl=en
 
Messages from newly joined members are subject to moderation.
Download RoboFab and documentation at http://robofab.com
---
You received this message because you are subscribed to the Google Groups "RoboFab" group.
To unsubscribe from this group and stop receiving emails from it, send an email to robofab+u...@googlegroups.com.
For more options, visit https://groups.google.com/groups/opt_out.

Kannery Bosch

unread,
Dec 2, 2013, 8:25:58 AM12/2/13
to rob...@googlegroups.com
Thanks for the tips Mathieu and Frederik - I'm just looking to get the full documentation for RoboFab and RoboFont - and I thought generating it from the source would result in the most complete information on all the methods and attributes - one never seems to know if some needed bit has been left out of hand written documentation.

The makeDocumentation.py script does generate a well structured and color blocked "User Guide" in an HTML format. This can also be output to PDF and can be pretty useful. But of course the script is wagering that the source coder has included well written comments.

I was mainly looking for the new RoboFont specific techniques to replace the old FontLab ones, for example, to get at the glyph index:

print 'Glyph ID 4:', font.glyphOrder[4] #THE ROBOFONT WAY

print 'Glyph ID 4:', font.glyphs[4] # OLD FONTLAB WAY


I'm starting to get the hang of the RoboFont way and it seems pretty cool. But I do come up with questions. I tried to join the RoboFont forums a couple of times over the last year but did not get a reply from the sign up robot. If there is an alternative way to join, I would love to start participating in the RoboFont community. If you see this Frederik, maybe you can send me a suggestion on gaining access to doc.robofont.com/forums

thanks,
Kannery Bosch

kan.bosch  ((at))  gmail.com

Frederik Berlaen

unread,
Dec 2, 2013, 9:29:39 AM12/2/13
to rob...@googlegroups.com
He Kannery

Never used the `font.glyphs` :)

an other option to get all robofab callbacks in RoboFont:

"""
import pydoc
from mojo.UI import HelpWindow

doc = pydoc.HTMLDoc()

html = doc.document(RFont)
HelpWindow(htmlString=html)
"""


(will mail you offlist for the getting forum access, to much spam....)


gr Frederik



Reply all
Reply to author
Forward
0 new messages