sfepy/sfepy — Issue #26: user's guide
Author: rc
Created: 2012-01-30 10:24:13+00:00
State: open

I believe we need a user's guide. Same rationale as here:

http://code.google.com/p/sympy/issues/detail?id=717

Sample pages are here:

http://sympy.googlecode.com/svn/materials/usersguide/guide.html

This is a long term issue, I don't think we should work on this right now.
But in the horizon of a few months, we should fix this.

Migrated from http://code.google.com/p/sfepy/issues/detail?id=22

earlier comments

robert.cimrman said, at 2008-02-18T12:47:04.000Z:

Yes. I have looked at the sympy guide - it looks very nice. By the time we get to
this the right tools to write the docs with should be settled. I hate editing xml, so
we should keep an eye on alternatives.

ondrej.certik said, at 2008-02-18T12:51:39.000Z:

Agree. We should use tools that people use though. And important here is how it looks
like.

ondrej.certik said, at 2008-03-03T14:16:54.000Z:

I suggest to write our userguide in rst. The same way as in sympy, ipython and others.

Also, there should be a chapter "how to learn FEM", with the points made in:

http://groups.google.com/group/sfepy-devel/browse_thread/thread/2dc74465058fe558/

This is imho quite a high priority. Once we have all the tools for producing
documentation ready, we'll simply add a section whenever we implement something, and
that's it.

robert.cimrman said, at 2008-03-03T15:02:10.000Z:

I am fine with rst. Do you have some details regarding how the groups you listed use
it? Yes, it is a high priority task.

ondrej.certik said, at 2008-03-03T16:00:17.000Z:

Well, they are just starting. For example yesterday I wrote a pdf generation code for
ipython1. Well, we just go ahead, write it in rst, and maybe run it throug rst -> xml
-> prettydoc

robert.cimrman said, at 2009-11-24T13:38:30.000Z:

The documentation is now at [1], and is based on sphinx. It's work in progress still...

[1] http://docs.sfepy.org/doc/

freevryheid said, at 2010-04-12T23:59:19.000Z:

On ubuntu the installation requirements should include python-dev (Header files and a
static library for Python), which is not installed by default.

freevryheid said, at 2010-04-13T00:03:25.000Z:

Installation: setuptools also required

freevryheid said, at 2010-04-13T00:06:22.000Z:

Installation: gfortran also required

robert.cimrman said, at 2010-04-13T07:07:28.000Z:

OK, I will add those to the installation docs. Do you know why gfortran is needed? We
have no fortran dependency...

freevryheid said, at 2010-06-17T13:43:46.000Z:

hmm - not sure why gfortran was needed? BLAS perhaps? Please disregard. Found a spello.

robert.cimrman said, at 2010-06-21T08:39:04.000Z:

Thanks, applied!