Initial merge of pyvisi into esys repository.

 1 % $Id: admin.tex,v 1.4 2005/06/24 00:27:34 paultcochrane Exp$ 2 3 \documentclass[12pt,a4paper]{article} 4 5 \begin{document} 6 7 \section{Epydoc} 8 9 Epydoc is used to build the API documentation of pyvisi. It strips out 10 relevant information from the python code and the docstrings in the python 11 code to generate a set of web pages documenting the different classes and 12 functions defined. 13 14 The command used to run epydoc is: 15 \begin{verbatim} 16 epydoc --html -o doc/api_epydoc -n pyvisi pyvisi 17 \end{verbatim} 18 19 \section{A-A-P} 20 21 The tool, \texttt{aap} is used to build the website html files from their base 22 (.part) files, and to publish them to the website. To build or refresh the 23 html source from the .part files, use: 24 \begin{verbatim} 25 aap 26 \end{verbatim} 27 To send the files to the website (known as publishing'' in aap parlance) 28 use: 29 \begin{verbatim} 30 aap publish 31 \end{verbatim} 32 33 \section{Todo list} 34 35 To add a new todo item, use the \texttt{devtodo} (\texttt{todo}) command. 36 Then, to produce the TODO list, use \texttt{todo -T}, and commit the changes 37 to the repository. 38 39 \section{Pylint} 40 41 Pylint is a handy tool to check the quality of the code. It is like the old 42 lint program for C, and gives a lot of checking and helpful output. To 43 generate html output from pylint use the following command from the pyvisi 44 main directory: 45 \begin{verbatim} 46 pylint --html=y pyvisi > pylint.pyvisi.html 47 \end{verbatim} 48 49 \end{document}