Commits

German Larrain  committed 60f9d96

docs: extracted and improved instructions to create diagrams of the code

  • Participants
  • Parent commits ff6bf6c

Comments (0)

Files changed (2)

File docs/diagrams generation.txt

+Graphviz and pyreverse (now distributed with
+pylint https://pypi.python.org/pypi/pylint/) 
+
+	To generate PDF class diagrams based on a Python module/package
+	$ pyreverse path/to/module.py
+	$ dot -Tpdf -O classes_No_Name.dot
+
+	To hide attributes and methods in the class boxes add option -k
+	$ pyreverse -k path/to/module.py
+
+	The diagrams can be manually edited by manipulating entries in the .dot
+	file, which is just a text file that defines the elements of the diagram.

File docs/epydoc/build documentation.txt

 
 To build the docs, run the following command from the project main directory
 	epydoc -v --config docs/epydoc/epydoc.cfg --exclude ars.lib.* ars/
-
-To generate class diagrams based on a Python module
-	pyreverse path/to/module.py
-	dot -Tps classes_No_Name.dot -o graph1.ps