Difference between revisions of "Manual"
| Line 5: | Line 5: | ||
* Latest builded manual http://download.gna.org/relax/manual | * Latest builded manual http://download.gna.org/relax/manual | ||
| − | = Build pdf manual = | + | = Build manual = |
| + | == Latex requirements == | ||
| + | The [http://www.ctan.org/pkg/latex2html latex2html] latex package is necessary. A [http://miktex.org/ windows MiKTeX] should fetch it automatically. If you have a linux [http://www.tug.org/texlive/ texlive] installation, extra packages can be installed with [http://en.wikibooks.org/wiki/LaTeX/Installing_Extra_Packages tlmgr]. | ||
| + | tlmgr install latex2html | ||
| + | You can check if is already available | ||
| + | kpsewhich latex2html | ||
| + | |||
| + | == Build pdf manual == | ||
The manual ends up in '''docs/relax.pdf''' | The manual ends up in '''docs/relax.pdf''' | ||
| Line 16: | Line 23: | ||
scons user_manual_pdf_nofetch | scons user_manual_pdf_nofetch | ||
| − | = Build html manual = | + | == Build html manual == |
Go to the relax base directory.<br> | Go to the relax base directory.<br> | ||
Revision as of 20:27, 20 August 2013
Contents
See
The homepage manual
- html http://www.nmr-relax.com/manual/index.html
- pdf http://download.gna.org/relax/manual/relax.pdf
- Latest builded manual http://download.gna.org/relax/manual
Build manual
Latex requirements
The latex2html latex package is necessary. A windows MiKTeX should fetch it automatically. If you have a linux texlive installation, extra packages can be installed with tlmgr.
tlmgr install latex2html
You can check if is already available
kpsewhich latex2html
Build pdf manual
The manual ends up in docs/relax.pdf
Go to the relax base directory.
Then issue the command
scons user_manual_pdf
This triggers a range of functions, which create some files. If they do not need to be updated, following compilation can be performed much faster with
scons user_manual_pdf_nofetch
Build html manual
Go to the relax base directory.
Then issue the command
scons user_manual_html
And faster
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.
take the win32 bit versions.
Open WinPython Control Panel, and drag the .exe into the window.
Linux
sudo yum install epydoc sudo yum install graphviz-python
Build API
You need to run 'scons clean' first to remove the *.pyc files and any other temporary files.
scons clean
Build the API documentation
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.
The wxPython indentation errors are also fine. epydoc is scanning the wx module docstrings, but it cannot be stopped.
The "Unable to render Graphviz dot graph" are because the Graphviz software is not available.
Windows binaries are available though (http://www.graphviz.org).
