Epydoc documentation

Asked by Anton Gladky

Hi, all!
How to generate Epydoc documentation on local machine like http://esys.esscc.uq.edu.au/esys-particle_python_doc/current
/pythonapi/html/index.html ?

Thank you

Question information

Language:
English Edit question
Status:
Solved
For:
ESyS-Particle Edit question
Assignee:
No assignee Edit question
Solved by:
Dion Weatherley
Solved:
Last query:
Last reply:
Revision history for this message
Best Dion Weatherley (d-weatherley) said :
#1

Hi Anton,

To generate the python API docs on a local machine you need epydoc installed on that machine before you configure and build ESyS-Particle from source code. Ensure you *do not* include the '--without-epydoc' argument when you run ./configure. The python API docs will be generated during 'make install'. The default directory containing the API documentation is:
/usr/local/share/doc/esys-particle-2.0/

If you added a '--prefix=/path/to/install/esys/' argument to ./configure, then the location of the API documentation will be:
/path/to/install/esys/share/doc/esys-particle-2.0/

The path to the index.html file for viewing the documentation in your browser is:
/path/to/install/esys/share/doc/esys-particle-2.0/pythonapi/html/index.html

or for the default install path:
/usr/local/share/doc/esys-particle-2.0/pythonapi/html/index.html

Depending on the version of epydoc installed on your local machine, the documentation may look a bit different to that on the esys-particle website. If you have major problems or errors, please let me know. Vince recently did quite a lot of work to fix errors and bugs associated with generating the API docs so hopefully you won't encounter major problems

Cheers,

Dion.

P.S. For users of the ESyS-Particle LiveDVD or the workshop LiveUSB flash drives, the python API documentation is installed in /usr/local/share/doc/esys-particle-2.0/.

Revision history for this message
Anton Gladky (gladky-anton) said :
#2

Thanks Dion Weatherley, that solved my question.

Revision history for this message
Anton Gladky (gladky-anton) said :
#3

Thank you, Dion!

The documentation was installed on my machine during installation in /usr/local/share/doc/