SfePy January 2010

sfepy@python.org

2 participants
4 discussions

basic term documentation
by Robert Cimrman 01 Feb '10

01 Feb '10

Hi, At [1] you can see the basic sphinx documentation of the terms (scroll down). It took me some time to convert the docstrings, but the result is not bad. The new sources are for the moment at [2], I will push it to the master repo after I get some feedback. I do not know yet how to hide the common methods of the terms, i.e. do the following split: 1. The Term class documentation with all the common methods 2. The Term subclass documentation with only Description, Definition, and possibly the extra methods not already defined by Term. After this is done, we could happily abandon the old way of generating the sfepy_manual.pdf (which is broken now anyway, as the docstrings changed). r. [1] http://rc.github.com/sfepy/developer_guide.html [2] http://github.com/rc/sfepy

2 11

reorganizing examples (issue 103)
by Robert Cimrman 28 Jan '10

28 Jan '10

Hi, at [1] you can find a first version of my attempt to clean up a bit the directory structure and naming of the example problems. I did not fix the file contents yet, so the tests do not pass, nevertheless I would appreciate comments on the used naming scheme and structure. At the top level, database/ -> meshes/, input/ -> examples and examples/ -> examples/standalone. Note that a single mesh is often reused in several examples, therefore I did not put the meshes directly to the same directories as the corresponding examples. r. [1] http://github.com/rc/sfepy/tree/examples

1 1

emacs, sphinx & LaTeX
by Robert Cimrman 25 Jan '10

25 Jan '10

FYI: when writing the sphinx docs, I use the following regular expression in Emacs's query replace regexp command: from \$$[^$]+$\$ to :math:`\1` That way I can write the inline math (on a single line!) using the usual $ signs and replace them just before making the docs. Simple, but helps. r.

1 0

docs again
by Robert Cimrman 22 Jan '10

22 Jan '10

Hello in 2010! I have finally resolved the segfault problem with sphinx (btw. completely unrelated to sphinx). Logan, the documentation version at your github site (= what is at docs.sfepy.org) is the most recent, right? I will put the docs of the git version to [1], and convert the term docstrings soon. r. [1] http://docs.sfepy.org/doc-devel

2 2

2022

2021

2020

2019

2018

2017

2016

2015

2014

2013

2012

2011

2010

2009

2008

SfePy January 2010