On Wed, Oct 28, 2009 at 3:55 AM, Robert Cimrman <cimr...(a)ntc.zcu.cz> wrote:
Logan Sorenson wrote:
I finally got some time to update the sphinx documentation. The final
result is at  and the git repo can be cloned from . 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
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  might do as well for the moment, IMHO.
Ok, this makes a lot more sense to me from a new user perspective. But
I don't think my efforts have been in vain, since as you mentioned,
the docs look great (thanks mostly to sphinx of course :) )! So I
think I'll take what I currently have as the starting point for the
user guide and instead write a new tutorial based off the commented
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...)
It seems that there never is enough time for everything we want to
do...good luck with your deadlines!