Hi Logan,
Logan Sorenson wrote:
Hi,
I finally got some time to update the sphinx documentation. The final result is at [1] and the git repo can be cloned from [2]. Basically, so far I've just pulled stuff from the google pages and converted into sphinx format and did some polishing. I think it's a good start, but definitely needs more work! For example, the tutorial right now is more "theoretical", and may not be "practical" enough for a new user to understand...probably this can be separated into a simpler tutorial and then an advanced tutorial or reference section, especially the problem description format.
Awesome, it looks great! The LaTeX stuff is rendered very nice, cool. And I have learnt how to define the LaTeX preamble in doc/conf.py, thanks a lot.
I agree that the tutorial, as it is, is not too useful for actually starting to use sfepy in terms of defining your own problems. (But it looks great!).
To improve this, I would start by rstifying one or both of the commented input files: input/poisson.py (scalar problem), and input/linear_elastic.py (vector field problem). What do you think? This could be complemented by a more theoretical info about FEM. A link to [3] might do as well for the moment, IMHO.
Also, I haven't had time to look into genDocs.py yet...
No problem. Me neither, I am swamped with stuff due to the end of this month. (Today is a public holiday here, nobody normal works...)
Thanks for your help! r.
[1] http://logansorenson.github.com/sfepy_doc2 [2] git://github.com/logansorenson/sfepy_doc2.git [3] http://en.wikipedia.org/wiki/Finite_element_method