Difference between revisions of "Manual"
(Created page with "== 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.gn...") |
(→See) |
||
| Line 5: | Line 5: | ||
* Latest builded manual http://download.gna.org/relax/manual | * Latest builded manual http://download.gna.org/relax/manual | ||
| + | == Build manual == | ||
| + | The manual ends up in '''docs/relax.pdf''' | ||
| + | Go to the relax base directory.<br> | ||
| + | Then issue the command | ||
| + | scons user_manual_pdf | ||
| + | |||
| + | = 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 | ||
| + | '''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.<br> | ||
| + | Windows binaries are available though (http://www.graphviz.org). | ||
| + | |||
| + | = See also = | ||
[[Category:FAQ]] | [[Category:FAQ]] | ||
Revision as of 19:11, 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
The manual ends up in docs/relax.pdf
Go to the relax base directory.
Then issue the command
scons user_manual_pdf
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).
