2009/12/10 Simon Loic <simon1l...@gmail.com> > Hi everyone, > Subsequent to this previous thread ( > http://www.mail-archive.com/pythonocc-users@gna.org/msg00826.html), I > launch a new one specific to the samples wiki page. > > The goal is to create a script, that will go through all samples, generate > representative screenshots and html pages describing the current sample. > Then someone (most likely Thomas), will be in charge to update the wiki > whenever the doc changes. > > So far, two tasks have emerged : > 1) Creating the html pages : > For this, sphinx have been mentioned. Epydoc could also be considered. Any > other options? > I think, we should discuss the generation scenario and the tool we will > use. > By scenario I mean, to what extent the generation should be automatic? Do > we handle it in an intrusive way (ie add some utility function in all the > samples)? ... >
According to me, the expected result must be a single web page for each sample, with one or more screenshots, the python source code being syntax highlighted. I don't know whether Sphinx or Epydoc are suitable for this purpose, they might be a good solution. The other one is to develop a simple script, let's say sample_to_html.py that parses the python sample, run it to generate the screenshot and create the html page. > 2) how to automatically create screenshots > Here also we should decide if we want to extend all the samples with a > utility function (which is easier I think) or to handle it with an external > script only. > Besides, Bryan raised the issue that while taking screenshot, no window > should popup. Thomas have you find a solution to this yet? > Nope. I ran a few tests and got many segfaults! I need more time to go further, without being sure that it's indeed possible. > > Please go ahead, giving your opinion on what is important or not, and > suggestions on how we should proceed... > Kind regards, > Loïc > > Thomas
_______________________________________________ Pythonocc-users mailing list Pythonocc-users@gna.org https://mail.gna.org/listinfo/pythonocc-users
