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 ==
The homepage manual
* html http://www.nmr-relax.com/manual/index.html
* Latest 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>
=== 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]]
