Trusted, Bureaucrats
4,223
edits
Changes
Jump to navigation
Jump to search
Added an intro sentence, and increased the depth of the sectioning.
The following is information about the relax manual. == Find the manual = See =
The homepage manual
* html http://www.nmr-relax.com/manual/index.html
* pdf http://download.gna.org/relax/manual/relax.pdf
* Latest builded built manual http://download.gna.org/relax/manual
== Get help ==
The help section in relax is the best you can get !
</source>
== Write to the mail lists to get personal help ==See the wiki page [[Mailing_archives | Mailing archives]], to read how to sign up and write to the mail archives.
== Build the manual ===== Latex requirements ===
The '''html.sty''' is needed from the latex package [http://www.ctan.org/pkg/latex2html latex2html].
<source lang="bash">
cd $HOME/Downloads ;
wget http://wwwmirrors.latex2htmlctan.org/~latex2htsupport/currentlatex2html/latex2html-2008.tar2012.gz tgz ;tar -xzf latex2html-2008.tar2012.gz tgz ;rm latex2html-2008.tar2012.gz tgz ;
cd `where latex | xargs dirname`
cd ../../texmf-dist/tex/latex
cp -r /$HOME/Downloads/latex2html-20082012/texinputs latex2html
# Then update latex index
texhash
cd $HOME/Downloads ;
wget http://www.latex2html.org/~latex2ht/current/latex2html-20082012.tar.gz ;tar -xzf latex2html-20082012.tar.gz ;rm latex2html-20082012.tar.gz ;cd latex2html-2008 2012 ;
mkdir build ;
./configure --help
</source>
=== Build pdf manual ===
The manual ends up in '''docs/relax.pdf'''
scons user_manual_pdf_nofetch
=== Build html manual ===
This needs quite some time to figure out to install and run latex2html.
scons user_manual_html_nofetch
== Build API (Application programming interface) documentation ==
The html documentation ends up in '''docs/api/'''
=== Epydoc python package installation ======= Windows epydoc ====
First: Download this packages, do not unpack them yet.
* epydoc http://www.lfd.uci.edu/~gohlke/pythonlibs/#epydoc
</source>
==== Linux ====
sudo yum install epydoc
sudo yum install graphviz-python
=== Build API ===
The API ends up in docs/api/index.html
scons api_manual_html
=== Regarding error messages ===
The "No documentation available!" errors are normal as these are for non-python files which are not part of relax. It's safe to ignore these.
Windows binaries are available though (http://www.graphviz.org).
== See also ==
[[Category:FAQ]]
