Skip to content

Commit c0762c0

Browse files
author
Noah Petherbridge
committed
Reorganize package, generate new documentation
Reorganize the RiveScript package. The bulk of the code has been moved to rivescript/rivescript.py, and __init__.py mostly just contains the meta information. This is because epydocs was getting confused by all the imports in __init__.py and generating documentation for third party modules. Usage of the rivescript module has not changed, you can still do "from rivescript import RiveScript"
1 parent 4ee8d40 commit c0762c0

29 files changed

Lines changed: 4860 additions & 6076 deletions

‎docs/api-objects.txt‎

Lines changed: 55 additions & 83 deletions
Original file line numberDiff line numberDiff line change
@@ -1,90 +1,62 @@
1-
rivescript rivescript-module.html
2-
rivescript.re_ws rivescript-module.html#re_ws
3-
rivescript.__credits__ rivescript-module.html#__credits__
4-
rivescript.rs_version rivescript-module.html#rs_version
5-
rivescript.__package__ rivescript-module.html#__package__
6-
rivescript.__maintainer__ rivescript-module.html#__maintainer__
7-
rivescript.re_nasties rivescript-module.html#re_nasties
8-
rivescript.re_equals rivescript-module.html#re_equals
9-
rivescript.re_wilds rivescript-module.html#re_wilds
10-
rivescript.re_inherit rivescript-module.html#re_inherit
11-
rivescript.re_weight rivescript-module.html#re_weight
12-
rivescript.re_objend rivescript-module.html#re_objend
13-
rivescript.re_rot13 rivescript-module.html#re_rot13
14-
rivescript.__status__ rivescript-module.html#__status__
15-
rivescript.__main__ rivescript.__main__-module.html
16-
rivescript.__main__.interactive_mode rivescript.interactive-module.html#interactive_mode
17-
rivescript.__main__.__package__ rivescript.__main__-module.html#__package__
18-
rivescript.interactive rivescript.interactive-module.html
19-
rivescript.interactive.__package__ rivescript.interactive-module.html#__package__
20-
rivescript.interactive.interactive_mode rivescript.interactive-module.html#interactive_mode
21-
rivescript.interactive.json_in rivescript.interactive-module.html#json_in
221
rivescript.python rivescript.python-module.html
232
rivescript.python.__package__ rivescript.python-module.html#__package__
24-
rivescript.RiveScript rivescript.RiveScript-class.html
25-
rivescript.RiveScript._depth rivescript.RiveScript-class.html#_depth
26-
rivescript.RiveScript._thats rivescript.RiveScript-class.html#_thats
27-
rivescript.RiveScript.stream rivescript.RiveScript-class.html#stream
28-
rivescript.RiveScript.thaw_uservars rivescript.RiveScript-class.html#thaw_uservars
29-
rivescript.RiveScript._lineage rivescript.RiveScript-class.html#_lineage
30-
rivescript.RiveScript._users rivescript.RiveScript-class.html#_users
31-
rivescript.RiveScript._dump rivescript.RiveScript-class.html#_dump
32-
rivescript.RiveScript.set_global rivescript.RiveScript-class.html#set_global
33-
rivescript.RiveScript._word_count rivescript.RiveScript-class.html#_word_count
34-
rivescript.RiveScript._find_trigger_by_inheritence rivescript.RiveScript-class.html#_find_trigger_by_inheritence
35-
rivescript.RiveScript._getreply rivescript.RiveScript-class.html#_getreply
36-
rivescript.RiveScript.check_syntax rivescript.RiveScript-class.html#check_syntax
37-
rivescript.RiveScript.__init__ rivescript.RiveScript-class.html#__init__
38-
rivescript.RiveScript.set_handler rivescript.RiveScript-class.html#set_handler
39-
rivescript.RiveScript._strict rivescript.RiveScript-class.html#_strict
40-
rivescript.RiveScript._debug rivescript.RiveScript-class.html#_debug
41-
rivescript.RiveScript.set_subroutine rivescript.RiveScript-class.html#set_subroutine
42-
rivescript.RiveScript._substitute rivescript.RiveScript-class.html#_substitute
43-
rivescript.RiveScript._subs rivescript.RiveScript-class.html#_subs
44-
rivescript.RiveScript.sort_replies rivescript.RiveScript-class.html#sort_replies
45-
rivescript.RiveScript._gvars rivescript.RiveScript-class.html#_gvars
46-
rivescript.RiveScript._person rivescript.RiveScript-class.html#_person
47-
rivescript.RiveScript._topic_triggers rivescript.RiveScript-class.html#_topic_triggers
48-
rivescript.RiveScript._init_sort_track rivescript.RiveScript-class.html#_init_sort_track
49-
rivescript.RiveScript._topics rivescript.RiveScript-class.html#_topics
50-
rivescript.RiveScript.reply rivescript.RiveScript-class.html#reply
51-
rivescript.RiveScript.load_file rivescript.RiveScript-class.html#load_file
52-
rivescript.RiveScript._initTT rivescript.RiveScript-class.html#_initTT
53-
rivescript.RiveScript.clear_uservars rivescript.RiveScript-class.html#clear_uservars
54-
rivescript.RiveScript.last_match rivescript.RiveScript-class.html#last_match
55-
rivescript.RiveScript._handlers rivescript.RiveScript-class.html#_handlers
56-
rivescript.RiveScript._sorted rivescript.RiveScript-class.html#_sorted
57-
rivescript.RiveScript.freeze_uservars rivescript.RiveScript-class.html#freeze_uservars
58-
rivescript.RiveScript.get_uservars rivescript.RiveScript-class.html#get_uservars
59-
rivescript.RiveScript.set_person rivescript.RiveScript-class.html#set_person
60-
rivescript.RiveScript._is_atomic rivescript.RiveScript-class.html#_is_atomic
61-
rivescript.RiveScript._sort_that_triggers rivescript.RiveScript-class.html#_sort_that_triggers
62-
rivescript.RiveScript.VERSION rivescript.RiveScript-class.html#VERSION
63-
rivescript.RiveScript._format_message rivescript.RiveScript-class.html#_format_message
64-
rivescript.RiveScript._logf rivescript.RiveScript-class.html#_logf
65-
rivescript.RiveScript.get_uservar rivescript.RiveScript-class.html#get_uservar
66-
rivescript.RiveScript._sort_trigger_set rivescript.RiveScript-class.html#_sort_trigger_set
67-
rivescript.RiveScript._rot13 rivescript.RiveScript-class.html#_rot13
68-
rivescript.RiveScript._sort_list rivescript.RiveScript-class.html#_sort_list
69-
rivescript.RiveScript._reply_regexp rivescript.RiveScript-class.html#_reply_regexp
70-
rivescript.RiveScript._objlangs rivescript.RiveScript-class.html#_objlangs
71-
rivescript.RiveScript._warn rivescript.RiveScript-class.html#_warn
72-
rivescript.RiveScript._strip_nasties rivescript.RiveScript-class.html#_strip_nasties
73-
rivescript.RiveScript._arrays rivescript.RiveScript-class.html#_arrays
74-
rivescript.RiveScript.set_substitution rivescript.RiveScript-class.html#set_substitution
75-
rivescript.RiveScript._get_topic_tree rivescript.RiveScript-class.html#_get_topic_tree
76-
rivescript.RiveScript.set_variable rivescript.RiveScript-class.html#set_variable
77-
rivescript.RiveScript._string_format rivescript.RiveScript-class.html#_string_format
78-
rivescript.RiveScript._bvars rivescript.RiveScript-class.html#_bvars
79-
rivescript.RiveScript.load_directory rivescript.RiveScript-class.html#load_directory
80-
rivescript.RiveScript._process_tags rivescript.RiveScript-class.html#_process_tags
81-
rivescript.RiveScript._includes rivescript.RiveScript-class.html#_includes
82-
rivescript.RiveScript.set_uservar rivescript.RiveScript-class.html#set_uservar
83-
rivescript.RiveScript._freeze rivescript.RiveScript-class.html#_freeze
84-
rivescript.RiveScript._parse rivescript.RiveScript-class.html#_parse
85-
rivescript.RiveScript._say rivescript.RiveScript-class.html#_say
3+
rivescript.rivescript rivescript.rivescript-module.html
4+
rivescript.rivescript.re_wilds rivescript.rivescript-module.html#re_wilds
5+
rivescript.rivescript.re_inherit rivescript.rivescript-module.html#re_inherit
6+
rivescript.rivescript.re_weight rivescript.rivescript-module.html#re_weight
7+
rivescript.rivescript.re_equals rivescript.rivescript-module.html#re_equals
8+
rivescript.rivescript.re_objend rivescript.rivescript-module.html#re_objend
9+
rivescript.rivescript.rs_version rivescript.rivescript-module.html#rs_version
10+
rivescript.rivescript.__package__ rivescript.rivescript-module.html#__package__
11+
rivescript.rivescript.re_nasties rivescript.rivescript-module.html#re_nasties
12+
rivescript.rivescript.re_ws rivescript.rivescript-module.html#re_ws
8613
rivescript.python.PyRiveObjects rivescript.python.PyRiveObjects-class.html
8714
rivescript.python.PyRiveObjects.load rivescript.python.PyRiveObjects-class.html#load
8815
rivescript.python.PyRiveObjects._objects rivescript.python.PyRiveObjects-class.html#_objects
8916
rivescript.python.PyRiveObjects.call rivescript.python.PyRiveObjects-class.html#call
9017
rivescript.python.PyRiveObjects.__init__ rivescript.python.PyRiveObjects-class.html#__init__
18+
rivescript.rivescript.RiveScript rivescript.rivescript.RiveScript-class.html
19+
rivescript.rivescript.RiveScript.stream rivescript.rivescript.RiveScript-class.html#stream
20+
rivescript.rivescript.RiveScript.thaw_uservars rivescript.rivescript.RiveScript-class.html#thaw_uservars
21+
rivescript.rivescript.RiveScript._dump rivescript.rivescript.RiveScript-class.html#_dump
22+
rivescript.rivescript.RiveScript.set_global rivescript.rivescript.RiveScript-class.html#set_global
23+
rivescript.rivescript.RiveScript._word_count rivescript.rivescript.RiveScript-class.html#_word_count
24+
rivescript.rivescript.RiveScript._find_trigger_by_inheritence rivescript.rivescript.RiveScript-class.html#_find_trigger_by_inheritence
25+
rivescript.rivescript.RiveScript.check_syntax rivescript.rivescript.RiveScript-class.html#check_syntax
26+
rivescript.rivescript.RiveScript._getreply rivescript.rivescript.RiveScript-class.html#_getreply
27+
rivescript.rivescript.RiveScript.__init__ rivescript.rivescript.RiveScript-class.html#__init__
28+
rivescript.rivescript.RiveScript.set_handler rivescript.rivescript.RiveScript-class.html#set_handler
29+
rivescript.rivescript.RiveScript.set_variable rivescript.rivescript.RiveScript-class.html#set_variable
30+
rivescript.rivescript.RiveScript.set_subroutine rivescript.rivescript.RiveScript-class.html#set_subroutine
31+
rivescript.rivescript.RiveScript._substitute rivescript.rivescript.RiveScript-class.html#_substitute
32+
rivescript.rivescript.RiveScript.sort_replies rivescript.rivescript.RiveScript-class.html#sort_replies
33+
rivescript.rivescript.RiveScript._topic_triggers rivescript.rivescript.RiveScript-class.html#_topic_triggers
34+
rivescript.rivescript.RiveScript._init_sort_track rivescript.rivescript.RiveScript-class.html#_init_sort_track
35+
rivescript.rivescript.RiveScript.current_user rivescript.rivescript.RiveScript-class.html#current_user
36+
rivescript.rivescript.RiveScript.reply rivescript.rivescript.RiveScript-class.html#reply
37+
rivescript.rivescript.RiveScript.load_file rivescript.rivescript.RiveScript-class.html#load_file
38+
rivescript.rivescript.RiveScript._initTT rivescript.rivescript.RiveScript-class.html#_initTT
39+
rivescript.rivescript.RiveScript.clear_uservars rivescript.rivescript.RiveScript-class.html#clear_uservars
40+
rivescript.rivescript.RiveScript.last_match rivescript.rivescript.RiveScript-class.html#last_match
41+
rivescript.rivescript.RiveScript.trigger_info rivescript.rivescript.RiveScript-class.html#trigger_info
42+
rivescript.rivescript.RiveScript.freeze_uservars rivescript.rivescript.RiveScript-class.html#freeze_uservars
43+
rivescript.rivescript.RiveScript.get_uservars rivescript.rivescript.RiveScript-class.html#get_uservars
44+
rivescript.rivescript.RiveScript.set_person rivescript.rivescript.RiveScript-class.html#set_person
45+
rivescript.rivescript.RiveScript._is_atomic rivescript.rivescript.RiveScript-class.html#_is_atomic
46+
rivescript.rivescript.RiveScript._sort_list rivescript.rivescript.RiveScript-class.html#_sort_list
47+
rivescript.rivescript.RiveScript.VERSION rivescript.rivescript.RiveScript-class.html#VERSION
48+
rivescript.rivescript.RiveScript._format_message rivescript.rivescript.RiveScript-class.html#_format_message
49+
rivescript.rivescript.RiveScript.get_uservar rivescript.rivescript.RiveScript-class.html#get_uservar
50+
rivescript.rivescript.RiveScript._sort_trigger_set rivescript.rivescript.RiveScript-class.html#_sort_trigger_set
51+
rivescript.rivescript.RiveScript._sort_that_triggers rivescript.rivescript.RiveScript-class.html#_sort_that_triggers
52+
rivescript.rivescript.RiveScript._reply_regexp rivescript.rivescript.RiveScript-class.html#_reply_regexp
53+
rivescript.rivescript.RiveScript._warn rivescript.rivescript.RiveScript-class.html#_warn
54+
rivescript.rivescript.RiveScript._strip_nasties rivescript.rivescript.RiveScript-class.html#_strip_nasties
55+
rivescript.rivescript.RiveScript.set_substitution rivescript.rivescript.RiveScript-class.html#set_substitution
56+
rivescript.rivescript.RiveScript._get_topic_tree rivescript.rivescript.RiveScript-class.html#_get_topic_tree
57+
rivescript.rivescript.RiveScript._string_format rivescript.rivescript.RiveScript-class.html#_string_format
58+
rivescript.rivescript.RiveScript.load_directory rivescript.rivescript.RiveScript-class.html#load_directory
59+
rivescript.rivescript.RiveScript._process_tags rivescript.rivescript.RiveScript-class.html#_process_tags
60+
rivescript.rivescript.RiveScript.set_uservar rivescript.rivescript.RiveScript-class.html#set_uservar
61+
rivescript.rivescript.RiveScript._parse rivescript.rivescript.RiveScript-class.html#_parse
62+
rivescript.rivescript.RiveScript._say rivescript.rivescript.RiveScript-class.html#_say

‎docs/class-tree.html‎

Lines changed: 3 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,6 @@
1414
<table class="navbar" border="0" width="100%" cellpadding="0"
1515
bgcolor="#a0c0ff" cellspacing="0">
1616
<tr valign="middle">
17-
<!-- Home link -->
18-
<th>&nbsp;&nbsp;&nbsp;<a
19-
href="rivescript-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
2017

2118
<!-- Tree link -->
2219
<th bgcolor="#70b0f0" class="navbar-select"
@@ -63,17 +60,14 @@ <h1 class="epydoc">Class Hierarchy</h1>
6360
<li> <strong class="uidlink"><a href="rivescript.python.PyRiveObjects-class.html">rivescript.python.PyRiveObjects</a></strong>:
6461
<em class="summary">A RiveScript object handler for Python code.</em>
6562
</li>
66-
<li> <strong class="uidlink"><a href="rivescript.RiveScript-class.html" onclick="show_private();">rivescript.RiveScript</a></strong>:
67-
<em class="summary">A RiveScript interpreter for Python 2.</em>
63+
<li> <strong class="uidlink"><a href="rivescript.rivescript.RiveScript-class.html">rivescript.rivescript.RiveScript</a></strong>:
64+
<em class="summary">A RiveScript interpreter for Python 2 and 3.</em>
6865
</li>
6966
</ul>
7067
<!-- ==================== NAVIGATION BAR ==================== -->
7168
<table class="navbar" border="0" width="100%" cellpadding="0"
7269
bgcolor="#a0c0ff" cellspacing="0">
7370
<tr valign="middle">
74-
<!-- Home link -->
75-
<th>&nbsp;&nbsp;&nbsp;<a
76-
href="rivescript-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
7771

7872
<!-- Tree link -->
7973
<th bgcolor="#70b0f0" class="navbar-select"
@@ -98,7 +92,7 @@ <h1 class="epydoc">Class Hierarchy</h1>
9892
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
9993
<tr>
10094
<td align="left" class="footer">
101-
Generated by Epydoc 3.0.1 on Mon May 20 17:19:45 2013
95+
Generated by Epydoc 3.0.1 on Fri Jul 12 13:57:06 2013
10296
</td>
10397
<td align="right" class="footer">
10498
<a target="mainFrame" href="http://epydoc.sourceforge.net"

‎docs/frames.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,6 @@
1212
<frame src="toc-everything.html" name="moduleFrame"
1313
id="moduleFrame" />
1414
</frameset>
15-
<frame src="rivescript-module.html" name="mainFrame" id="mainFrame" />
15+
<frame src="module-tree.html" name="mainFrame" id="mainFrame" />
1616
</frameset>
1717
</html>

‎docs/help.html‎

Lines changed: 1 addition & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,6 @@
1414
<table class="navbar" border="0" width="100%" cellpadding="0"
1515
bgcolor="#a0c0ff" cellspacing="0">
1616
<tr valign="middle">
17-
<!-- Home link -->
18-
<th>&nbsp;&nbsp;&nbsp;<a
19-
href="rivescript-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
2017

2118
<!-- Tree link -->
2219
<th>&nbsp;&nbsp;&nbsp;<a
@@ -229,9 +226,6 @@ <h2> The Navigation Bar </h2>
229226
<table class="navbar" border="0" width="100%" cellpadding="0"
230227
bgcolor="#a0c0ff" cellspacing="0">
231228
<tr valign="middle">
232-
<!-- Home link -->
233-
<th>&nbsp;&nbsp;&nbsp;<a
234-
href="rivescript-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
235229

236230
<!-- Tree link -->
237231
<th>&nbsp;&nbsp;&nbsp;<a
@@ -256,7 +250,7 @@ <h2> The Navigation Bar </h2>
256250
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
257251
<tr>
258252
<td align="left" class="footer">
259-
Generated by Epydoc 3.0.1 on Mon May 20 17:19:45 2013
253+
Generated by Epydoc 3.0.1 on Fri Jul 12 13:57:06 2013
260254
</td>
261255
<td align="right" class="footer">
262256
<a target="mainFrame" href="http://epydoc.sourceforge.net"

0 commit comments

Comments
 (0)