mpip / pfft

Parallel fast Fourier transforms
GNU General Public License v3.0
54 stars 23 forks source link

WIP: Sphinx document. #18

Open rainwoodman opened 9 years ago

rainwoodman commented 9 years ago

This is a work in progress.

To build, install python, then

easy_install [--user] sphinx

make -f Makefile-sphinx html latexpdf

The document can be found at _build/html/ and _build/latex/

if ghp-import is installed,

ghp-import -n -p doc/_build/html/

will put document to mpip.github.io/pfft.

I also added a few scripts (convert.sh) to convert tex to rst files.

Major issues currently are missing cross-links between sections; some lstinclude source files needs to be updated. And a few small issues with math.

How to best deal with these depends on if we want to abandon the tex files.

rainwoodman commented 9 years ago

BTW, here is an example of the html doc http://rainwoodman.github.io/pfft/

mpip commented 9 years ago

Looks great. Thank you. I will have a deeper look at it as soon as possible. At the moment I am working on a major PNFFT update.

Am 17.09.2015 um 02:08 schrieb Yu Feng:

BTW, here is an example of the html doc http://rainwoodman.github.io/pfft/

— Reply to this email directly or view it on GitHub https://github.com/mpip/pfft/pull/18#issuecomment-140929993.


Michael Pippig Technische Universität Chemnitz Faculty of Mathematics Reichenhainer Str. 39 09126 Chemnitz Germany

Phone: +49-371-531-37833 Fax: +49-371-531-837833 eMail: michael.pippig.tuc@gmail.com WWW: http://www.tu-chemnitz.de/~mpip