1. German Larrain
  2. ars

Commits

German Larrain  committed 4964814

doc: created 'epydoc' folder and moved the related files there

  • Participants
  • Parent commits d4dffba
  • Branches dev

Comments (0)

Files changed (4)

File docs/documentation generation.txt

-german@german-T400:~$ cd Prog/WS/PyCharm/MSc/ars/
-
-german@german-T400:~/Prog/WS/PyCharm/MSc/ars$ epydoc -v --config doc/epydoc.cfg ars/
-	+---------------------------------------------------------------------------------------------------------------------------------------------------------
-	| File /home/german/Prog/WS/PyCharm/MSc/ars/ars/exceptions.py, line 20, in ars.exceptions.ArsError
-	|   Warning: Line 23: Improper paragraph indentation.
-	|
-	+---------------------------------------------------------------------------------------------------------------------------------------------------------
-	| File /home/german/Prog/WS/PyCharm/MSc/ars/ars/exceptions.py, line 39, in ars.exceptions.JointError
-	|   Warning: Line 42: Improper paragraph indentation.
-	|
-	+---------------------------------------------------------------------------------------------------------------------------------------------------------
-	| File /home/german/Prog/WS/PyCharm/MSc/ars/ars/exceptions.py, line 31, in ars.exceptions.PhysicsEngineException
-	|   Warning: Line 34: Improper paragraph indentation.
-	|
-	+---------------------------------------------------------------------------------------------------------------------------------------------------------
-	| File /home/german/Prog/WS/PyCharm/MSc/ars/ars/exceptions.py, line 51, in ars.exceptions.PhysicsObjectCreationError
-	|   Warning: Line 54: Improper paragraph indentation.
-	|
-
-german@german-T400:~/Prog/WS/PyCharm/MSc/ars$ pyreverse
-	Usage:
-	  pyreverse [options] <packages>
-
-	  create UML diagrams for classes and modules in <packages>
-
-
-	Options:
-	  -h, --help            show this help message and exit
-	  -f <mode>, --filter-mode=<mode>
-							filter attributes and functions according to
-							<mode>. Correct modes are :
-							'PUB_ONLY' filter all non public attributes
-							[DEFAULT], equivalent to PRIVATE+SPECIAL_A
-							'ALL' no filter                             'SPECIAL'
-							filter Python special functions
-							except constructor                             'OTHER'
-							filter protected and private
-							attributes [current: PUB_ONLY]
-	  -c <class>, --class=<class>
-							create a class diagram with all classes related to
-							<class>; this uses by default the options -ASmy
-							[current: none]
-	  -a <ancestor>, --show-ancestors=<ancestor>
-							show <ancestor> generations of ancestor classes not in
-							<projects>
-	  -A, --all-ancestors   show all ancestors off all classes in <projects>
-	  -s <ass_level>, --show-associated=<ass_level>
-							show <ass_level> levels of associated classes not in
-							<projects>
-	  -S, --all-associated  show recursively all associated off all associated
-							classes
-	  -b, --show-builtin    include builtin objects in representation of classes
-	  -m [yn], --module-names=[yn]
-							include module name in representation of classes
-	  -k, --only-classnames
-							don't show attributes and methods in the class boxes;
-							this disables -f values
-	  -o <format>, --output=<format>
-							create a *.<format> output file if format available.
-							[current: dot]
-
-	  Astng loader:
-		--ignore=<file>     add <file> (may be a directory) to the black list. It
-							should be a base name, not a path. You may set this
-							option multiple times. [current: CVS]
-		-p <project name>, --project=<project name>
-							set the project name. [current: No Name]
-
-german@german-T400:~/Prog/WS/PyCharm/MSc/ars$ pyreverse --all-associated ars
-	parsing ars/__init__.py...
-	parsing /home/german/Prog/WS/PyCharm/MSc/ars/ars/__init__.py...
-	parsing /home/german/Prog/WS/PyCharm/MSc/ars/ars/constants.py...
-	...
-
-german@german-T400:~/Prog/WS/PyCharm/MSc/ars$ dot -Tps classes_No_Name.dot -o graph1.ps
-
-german@german-T400:~/Prog/WS/PyCharm/MSc/ars$ pyreverse --all-associated ars.model
-	parsing /home/german/Prog/WS/PyCharm/MSc/ars/ars/model/__init__.py...
-	parsing /home/german/Prog/WS/PyCharm/MSc/ars/ars/model/__init__.py...
-	parsing /home/german/Prog/WS/PyCharm/MSc/ars/ars/model/simulator/__init__.py...
-	...
-
-german@german-T400:~/Prog/WS/PyCharm/MSc/ars$ dot -Tps classes_No_Name.dot -o graph1.ps
-
-german@german-T400:~/Prog/WS/PyCharm/MSc/ars$ pyreverse --class=Sensor ars.model
-	parsing /home/german/Prog/WS/PyCharm/MSc/ars/ars/model/__init__.py...
-	parsing /home/german/Prog/WS/PyCharm/MSc/ars/ars/model/__init__.py...
-	parsing /home/german/Prog/WS/PyCharm/MSc/ars/ars/model/simulator/__init__.py...
-	...
-	Traceback (most recent call last):
-	  File "/usr/bin/pyreverse", line 4, in <module>
-		main.Run(sys.argv[1:])
-	  File "/usr/lib/python2.7/dist-packages/pylint/pyreverse/main.py", line 126, in __init__
-		PyreverseCommand(args)
-	  File "/usr/lib/python2.7/dist-packages/pylint/pyreverse/main.py", line 98, in __init__
-		self.run(args)
-	  File "/usr/lib/python2.7/dist-packages/pylint/pyreverse/main.py", line 112, in run
-		diadefs = handler.get_diadefs(project, linker)
-	  File "/usr/lib/python2.7/dist-packages/pylint/pyreverse/diadefslib.py", line 226, in get_diadefs
-		diagrams.append(generator.class_diagram(project, klass))
-	  File "/usr/lib/python2.7/dist-packages/pylint/pyreverse/diadefslib.py", line 194, in class_diagram
-		module, klass = klass.rsplit('.', 1)
-	ValueError: need more than 1 value to unpack
-
-german@german-T400:~/Prog/WS/PyCharm/MSc/ars$ pyreverse --class=ars.model.robot.sensors.Sensor ars.model
-	parsing /home/german/Prog/WS/PyCharm/MSc/ars/ars/model/__init__.py...
-	parsing /home/german/Prog/WS/PyCharm/MSc/ars/ars/model/__init__.py...
-	...
-
-german@german-T400:~/Prog/WS/PyCharm/MSc/ars$ dot -Tps classes_No_Name.dot -o graph2.ps
-
-german@german-T400:~/Prog/WS/PyCharm/MSc/ars$ pyreverse ars.model
-	parsing /home/german/Prog/WS/PyCharm/MSc/ars/ars/model/__init__.py...
-	parsing /home/german/Prog/WS/PyCharm/MSc/ars/ars/model/__init__.py...
-	parsing /home/german/Prog/WS/PyCharm/MSc/ars/ars/model/simulator/__init__.py...
-	...
-
-german@german-T400:~/Prog/WS/PyCharm/MSc/ars$ dot -Tps classes_No_Name.dot -o graph3.ps
-
-german@german-T400:~/Prog/WS/PyCharm/MSc/ars$ pyreverse --ignore=ars.model.contrib.ragdoll ars.model
-	parsing /home/german/Prog/WS/PyCharm/MSc/ars/ars/model/__init__.py...
-	parsing /home/german/Prog/WS/PyCharm/MSc/ars/ars/model/__init__.py...
-	parsing /home/german/Prog/WS/PyCharm/MSc/ars/ars/model/simulator/__init__.py...
-	...
-
-german@german-T400:~/Prog/WS/PyCharm/MSc/ars$ dot -Tps classes_No_Name.dot -o graph4.ps
-
-german@german-T400:~/Prog/WS/PyCharm/MSc/ars$ pyreverse --ignore=ars/model/contrib/ragdoll.py ars.model
-	parsing /home/german/Prog/WS/PyCharm/MSc/ars/ars/model/__init__.py...
-	parsing /home/german/Prog/WS/PyCharm/MSc/ars/ars/model/__init__.py...
-	parsing /home/german/Prog/WS/PyCharm/MSc/ars/ars/model/simulator/__init__.py...
-	...
-
-german@german-T400:~/Prog/WS/PyCharm/MSc/ars$ pyreverse --ignore "ars/model/contrib/ragdoll.py" ars.model
-	parsing /home/german/Prog/WS/PyCharm/MSc/ars/ars/model/__init__.py...
-	parsing /home/german/Prog/WS/PyCharm/MSc/ars/ars/model/__init__.py...
-	parsing /home/german/Prog/WS/PyCharm/MSc/ars/ars/model/simulator/__init__.py...
-	...
-
-german@german-T400:~/Prog/WS/PyCharm/MSc/ars$ pyreverse ars.model.robot
-	parsing /home/german/Prog/WS/PyCharm/MSc/ars/ars/model/robot/__init__.py...
-	parsing /home/german/Prog/WS/PyCharm/MSc/ars/ars/model/robot/__init__.py...
-	parsing /home/german/Prog/WS/PyCharm/MSc/ars/ars/model/robot/sensors.py...
-	parsing /home/german/Prog/WS/PyCharm/MSc/ars/ars/model/robot/actuators.py...
-	parsing /home/german/Prog/WS/PyCharm/MSc/ars/ars/model/robot/joints.py...
-
-german@german-T400:~/Prog/WS/PyCharm/MSc/ars$ dot -Tps classes_No_Name.dot -o graph5.ps
-
-german@german-T400:~/Prog/WS/PyCharm/MSc/ars$
-

File docs/epydoc.cfg

-[epydoc]
-
-name: Autonomous Robot Simulator
-url: http://sourceforge.net/projects/arsproject/
-
-# The list of modules to document.  Modules can be named using
-# dotted names, module filenames, or package directory names.
-# This option may be repeated.
-#modules: sys, os.path, re
-#modules: my/project/driver.py
-
-# Write html output to the directory "html_docs"
-output: html
-target: html_docs/
-
-# Include all automatically generated graphs.  These graphs are generated using Graphviz dot.
-graph: all
-
-# if not in the system path, set the location of graphviz dot executable
-# dotpath: /usr/local/bin/dot

File docs/epydoc/documentation generation.txt

View file
+german@german-T400:~$ cd Prog/WS/PyCharm/MSc/ars/
+
+german@german-T400:~/Prog/WS/PyCharm/MSc/ars$ epydoc -v --config doc/epydoc.cfg ars/
+	+---------------------------------------------------------------------------------------------------------------------------------------------------------
+	| File /home/german/Prog/WS/PyCharm/MSc/ars/ars/exceptions.py, line 20, in ars.exceptions.ArsError
+	|   Warning: Line 23: Improper paragraph indentation.
+	|
+	+---------------------------------------------------------------------------------------------------------------------------------------------------------
+	| File /home/german/Prog/WS/PyCharm/MSc/ars/ars/exceptions.py, line 39, in ars.exceptions.JointError
+	|   Warning: Line 42: Improper paragraph indentation.
+	|
+	+---------------------------------------------------------------------------------------------------------------------------------------------------------
+	| File /home/german/Prog/WS/PyCharm/MSc/ars/ars/exceptions.py, line 31, in ars.exceptions.PhysicsEngineException
+	|   Warning: Line 34: Improper paragraph indentation.
+	|
+	+---------------------------------------------------------------------------------------------------------------------------------------------------------
+	| File /home/german/Prog/WS/PyCharm/MSc/ars/ars/exceptions.py, line 51, in ars.exceptions.PhysicsObjectCreationError
+	|   Warning: Line 54: Improper paragraph indentation.
+	|
+
+german@german-T400:~/Prog/WS/PyCharm/MSc/ars$ pyreverse
+	Usage:
+	  pyreverse [options] <packages>
+
+	  create UML diagrams for classes and modules in <packages>
+
+
+	Options:
+	  -h, --help            show this help message and exit
+	  -f <mode>, --filter-mode=<mode>
+							filter attributes and functions according to
+							<mode>. Correct modes are :
+							'PUB_ONLY' filter all non public attributes
+							[DEFAULT], equivalent to PRIVATE+SPECIAL_A
+							'ALL' no filter                             'SPECIAL'
+							filter Python special functions
+							except constructor                             'OTHER'
+							filter protected and private
+							attributes [current: PUB_ONLY]
+	  -c <class>, --class=<class>
+							create a class diagram with all classes related to
+							<class>; this uses by default the options -ASmy
+							[current: none]
+	  -a <ancestor>, --show-ancestors=<ancestor>
+							show <ancestor> generations of ancestor classes not in
+							<projects>
+	  -A, --all-ancestors   show all ancestors off all classes in <projects>
+	  -s <ass_level>, --show-associated=<ass_level>
+							show <ass_level> levels of associated classes not in
+							<projects>
+	  -S, --all-associated  show recursively all associated off all associated
+							classes
+	  -b, --show-builtin    include builtin objects in representation of classes
+	  -m [yn], --module-names=[yn]
+							include module name in representation of classes
+	  -k, --only-classnames
+							don't show attributes and methods in the class boxes;
+							this disables -f values
+	  -o <format>, --output=<format>
+							create a *.<format> output file if format available.
+							[current: dot]
+
+	  Astng loader:
+		--ignore=<file>     add <file> (may be a directory) to the black list. It
+							should be a base name, not a path. You may set this
+							option multiple times. [current: CVS]
+		-p <project name>, --project=<project name>
+							set the project name. [current: No Name]
+
+german@german-T400:~/Prog/WS/PyCharm/MSc/ars$ pyreverse --all-associated ars
+	parsing ars/__init__.py...
+	parsing /home/german/Prog/WS/PyCharm/MSc/ars/ars/__init__.py...
+	parsing /home/german/Prog/WS/PyCharm/MSc/ars/ars/constants.py...
+	...
+
+german@german-T400:~/Prog/WS/PyCharm/MSc/ars$ dot -Tps classes_No_Name.dot -o graph1.ps
+
+german@german-T400:~/Prog/WS/PyCharm/MSc/ars$ pyreverse --all-associated ars.model
+	parsing /home/german/Prog/WS/PyCharm/MSc/ars/ars/model/__init__.py...
+	parsing /home/german/Prog/WS/PyCharm/MSc/ars/ars/model/__init__.py...
+	parsing /home/german/Prog/WS/PyCharm/MSc/ars/ars/model/simulator/__init__.py...
+	...
+
+german@german-T400:~/Prog/WS/PyCharm/MSc/ars$ dot -Tps classes_No_Name.dot -o graph1.ps
+
+german@german-T400:~/Prog/WS/PyCharm/MSc/ars$ pyreverse --class=Sensor ars.model
+	parsing /home/german/Prog/WS/PyCharm/MSc/ars/ars/model/__init__.py...
+	parsing /home/german/Prog/WS/PyCharm/MSc/ars/ars/model/__init__.py...
+	parsing /home/german/Prog/WS/PyCharm/MSc/ars/ars/model/simulator/__init__.py...
+	...
+	Traceback (most recent call last):
+	  File "/usr/bin/pyreverse", line 4, in <module>
+		main.Run(sys.argv[1:])
+	  File "/usr/lib/python2.7/dist-packages/pylint/pyreverse/main.py", line 126, in __init__
+		PyreverseCommand(args)
+	  File "/usr/lib/python2.7/dist-packages/pylint/pyreverse/main.py", line 98, in __init__
+		self.run(args)
+	  File "/usr/lib/python2.7/dist-packages/pylint/pyreverse/main.py", line 112, in run
+		diadefs = handler.get_diadefs(project, linker)
+	  File "/usr/lib/python2.7/dist-packages/pylint/pyreverse/diadefslib.py", line 226, in get_diadefs
+		diagrams.append(generator.class_diagram(project, klass))
+	  File "/usr/lib/python2.7/dist-packages/pylint/pyreverse/diadefslib.py", line 194, in class_diagram
+		module, klass = klass.rsplit('.', 1)
+	ValueError: need more than 1 value to unpack
+
+german@german-T400:~/Prog/WS/PyCharm/MSc/ars$ pyreverse --class=ars.model.robot.sensors.Sensor ars.model
+	parsing /home/german/Prog/WS/PyCharm/MSc/ars/ars/model/__init__.py...
+	parsing /home/german/Prog/WS/PyCharm/MSc/ars/ars/model/__init__.py...
+	...
+
+german@german-T400:~/Prog/WS/PyCharm/MSc/ars$ dot -Tps classes_No_Name.dot -o graph2.ps
+
+german@german-T400:~/Prog/WS/PyCharm/MSc/ars$ pyreverse ars.model
+	parsing /home/german/Prog/WS/PyCharm/MSc/ars/ars/model/__init__.py...
+	parsing /home/german/Prog/WS/PyCharm/MSc/ars/ars/model/__init__.py...
+	parsing /home/german/Prog/WS/PyCharm/MSc/ars/ars/model/simulator/__init__.py...
+	...
+
+german@german-T400:~/Prog/WS/PyCharm/MSc/ars$ dot -Tps classes_No_Name.dot -o graph3.ps
+
+german@german-T400:~/Prog/WS/PyCharm/MSc/ars$ pyreverse --ignore=ars.model.contrib.ragdoll ars.model
+	parsing /home/german/Prog/WS/PyCharm/MSc/ars/ars/model/__init__.py...
+	parsing /home/german/Prog/WS/PyCharm/MSc/ars/ars/model/__init__.py...
+	parsing /home/german/Prog/WS/PyCharm/MSc/ars/ars/model/simulator/__init__.py...
+	...
+
+german@german-T400:~/Prog/WS/PyCharm/MSc/ars$ dot -Tps classes_No_Name.dot -o graph4.ps
+
+german@german-T400:~/Prog/WS/PyCharm/MSc/ars$ pyreverse --ignore=ars/model/contrib/ragdoll.py ars.model
+	parsing /home/german/Prog/WS/PyCharm/MSc/ars/ars/model/__init__.py...
+	parsing /home/german/Prog/WS/PyCharm/MSc/ars/ars/model/__init__.py...
+	parsing /home/german/Prog/WS/PyCharm/MSc/ars/ars/model/simulator/__init__.py...
+	...
+
+german@german-T400:~/Prog/WS/PyCharm/MSc/ars$ pyreverse --ignore "ars/model/contrib/ragdoll.py" ars.model
+	parsing /home/german/Prog/WS/PyCharm/MSc/ars/ars/model/__init__.py...
+	parsing /home/german/Prog/WS/PyCharm/MSc/ars/ars/model/__init__.py...
+	parsing /home/german/Prog/WS/PyCharm/MSc/ars/ars/model/simulator/__init__.py...
+	...
+
+german@german-T400:~/Prog/WS/PyCharm/MSc/ars$ pyreverse ars.model.robot
+	parsing /home/german/Prog/WS/PyCharm/MSc/ars/ars/model/robot/__init__.py...
+	parsing /home/german/Prog/WS/PyCharm/MSc/ars/ars/model/robot/__init__.py...
+	parsing /home/german/Prog/WS/PyCharm/MSc/ars/ars/model/robot/sensors.py...
+	parsing /home/german/Prog/WS/PyCharm/MSc/ars/ars/model/robot/actuators.py...
+	parsing /home/german/Prog/WS/PyCharm/MSc/ars/ars/model/robot/joints.py...
+
+german@german-T400:~/Prog/WS/PyCharm/MSc/ars$ dot -Tps classes_No_Name.dot -o graph5.ps
+
+german@german-T400:~/Prog/WS/PyCharm/MSc/ars$
+

File docs/epydoc/epydoc.cfg

View file
+[epydoc]
+
+name: Autonomous Robot Simulator
+url: http://sourceforge.net/projects/arsproject/
+
+# The list of modules to document.  Modules can be named using
+# dotted names, module filenames, or package directory names.
+# This option may be repeated.
+#modules: sys, os.path, re
+#modules: my/project/driver.py
+
+# Write html output to the directory "html_docs"
+output: html
+target: html_docs/
+
+# Include all automatically generated graphs.  These graphs are generated using Graphviz dot.
+graph: all
+
+# if not in the system path, set the location of graphviz dot executable
+# dotpath: /usr/local/bin/dot