Skip to content

Commit 593fe3b

Browse files
committed
refactored docs generation
1 parent fe84b18 commit 593fe3b

35 files changed

+2700
-2456
lines changed

docs/api-objects.txt

Lines changed: 21 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,42 +1,41 @@
11
tdl tdl-module.html
2+
tdl._format_char tdl-module.html#_format_char
23
tdl.setTitle tdl-module.html#setTitle
3-
tdl._formatChar tdl-module.html#_formatChar
4+
tdl.__email__ tdl-module.html#__email__
45
tdl._var tdl-module.html#_var
56
tdl.flush tdl-module.html#flush
67
tdl.set_title tdl-module.html#set_title
7-
tdl._verify_colors tdl-module.html#_verify_colors
8-
tdl._set_char tdl-module.html#_set_char
8+
tdl._utf32_codec tdl-module.html#_utf32_codec
99
tdl._encodeString tdl-module.html#_encodeString
1010
tdl.screenshot tdl-module.html#screenshot
1111
tdl._rootinitialized tdl-module.html#_rootinitialized
1212
tdl._IS_PYTHON3 tdl-module.html#_IS_PYTHON3
1313
tdl.getFullscreen tdl-module.html#getFullscreen
1414
tdl._INTTYPES tdl-module.html#_INTTYPES
1515
tdl.__package__ tdl-module.html#__package__
16-
tdl._lib tdl-module.html#_lib
1716
tdl.init tdl-module.html#init
1817
tdl._rootConsoleRef tdl-module.html#_rootConsoleRef
1918
tdl.set_fps tdl-module.html#set_fps
2019
tdl._NUMTYPES tdl-module.html#_NUMTYPES
2120
tdl.set_fullscreen tdl-module.html#set_fullscreen
22-
tdl._put_char_ex tdl-module.html#_put_char_ex
23-
tdl._iscolor tdl-module.html#_iscolor
24-
tdl.forceResolution tdl-module.html#forceResolution
21+
tdl.int_types tdl-module.html#int_types
22+
tdl._lib tdl-module.html#_lib
23+
tdl._format_str tdl-module.html#_format_str
2524
tdl._fontinitialized tdl-module.html#_fontinitialized
25+
tdl.getFPS tdl-module.html#getFPS
2626
tdl._getImageSize tdl-module.html#_getImageSize
2727
tdl.setFPS tdl-module.html#setFPS
28-
tdl._set_fg tdl-module.html#_set_fg
28+
tdl._format_color tdl-module.html#_format_color
2929
tdl.force_resolution tdl-module.html#force_resolution
30-
tdl._set_bg tdl-module.html#_set_bg
30+
tdl.forceResolution tdl-module.html#forceResolution
3131
tdl.set_font tdl-module.html#set_font
3232
tdl.setFullscreen tdl-module.html#setFullscreen
33-
tdl.__email__ tdl-module.html#__email__
34-
tdl._put_char tdl-module.html#_put_char
33+
tdl._ffi tdl-module.html#_ffi
3534
tdl._STRTYPES tdl-module.html#_STRTYPES
3635
tdl.get_fullscreen tdl-module.html#get_fullscreen
3736
tdl.get_fps tdl-module.html#get_fps
3837
tdl.setFont tdl-module.html#setFont
39-
tdl.getFPS tdl-module.html#getFPS
38+
tdl._to_tcod_color tdl-module.html#_to_tcod_color
4039
tdl.event tdl.event-module.html
4140
tdl.event._keyNames tdl.event-module.html#_keyNames
4241
tdl.event._mousem tdl.event-module.html#_mousem
@@ -45,43 +44,45 @@ tdl.event.keyWait tdl.event-module.html#keyWait
4544
tdl.event._var tdl.event-module.html#_var
4645
tdl.event._mouser tdl.event-module.html#_mouser
4746
tdl.event.__package__ tdl.event-module.html#__package__
48-
tdl.event._lib tdl.event-module.html#_lib
4947
tdl.event.key_wait tdl.event-module.html#key_wait
5048
tdl.event.isWindowClosed tdl.event-module.html#isWindowClosed
5149
tdl.event.set_key_repeat tdl.event-module.html#set_key_repeat
5250
tdl.event.get tdl.event-module.html#get
51+
tdl.event._lib tdl.event-module.html#_lib
5352
tdl.event._pushedEvents tdl.event-module.html#_pushedEvents
5453
tdl.event._eventQueue tdl.event-module.html#_eventQueue
5554
tdl.event._mouseNames tdl.event-module.html#_mouseNames
5655
tdl.event.setKeyRepeat tdl.event-module.html#setKeyRepeat
5756
tdl.event._parseKeyNames tdl.event-module.html#_parseKeyNames
57+
tdl.event._ffi tdl.event-module.html#_ffi
5858
tdl.event._processEvents tdl.event-module.html#_processEvents
5959
tdl.event.is_window_closed tdl.event-module.html#is_window_closed
6060
tdl.event.push tdl.event-module.html#push
6161
tdl.map tdl.map-module.html
6262
tdl.map.quick_fov tdl.map-module.html#quick_fov
6363
tdl.map._var tdl.map-module.html#_var
64-
tdl.map._lib tdl.map-module.html#_lib
64+
tdl.map._ffi tdl.map-module.html#_ffi
6565
tdl.map.bresenham tdl.map-module.html#bresenham
6666
tdl.map.quickFOV tdl.map-module.html#quickFOV
6767
tdl.map.__package__ tdl.map-module.html#__package__
68+
tdl.map._lib tdl.map-module.html#_lib
6869
tdl.map._FOVTYPES tdl.map-module.html#_FOVTYPES
6970
tdl.map._get_fov_type tdl.map-module.html#_get_fov_type
7071
tdl.noise tdl.noise-module.html
7172
tdl.noise._MERSENNE_TWISTER tdl.noise-module.html#_MERSENNE_TWISTER
7273
tdl.noise._NOISE_MODES tdl.noise-module.html#_NOISE_MODES
73-
tdl.noise._lib tdl.noise-module.html#_lib
74+
tdl.noise._ffi tdl.noise-module.html#_ffi
7475
tdl.noise._MAX_DIMENSIONS tdl.noise-module.html#_MAX_DIMENSIONS
7576
tdl.noise.__package__ tdl.noise-module.html#__package__
7677
tdl.noise._MAX_OCTAVES tdl.noise-module.html#_MAX_OCTAVES
7778
tdl.noise._CARRY_WITH_MULTIPLY tdl.noise-module.html#_CARRY_WITH_MULTIPLY
7879
tdl.noise._var tdl.noise-module.html#_var
80+
tdl.noise._lib tdl.noise-module.html#_lib
7981
tdl.noise._NOISE_TYPES tdl.noise-module.html#_NOISE_TYPES
8082
tdl.Console tdl.Console-class.html
8183
tdl.Console.get_char tdl.Console-class.html#get_char
8284
tdl._BaseConsole.print_str tdl._BaseConsole-class.html#print_str
8385
tdl.Console._set_batch tdl.Console-class.html#_set_batch
84-
tdl._BaseConsole._bgblend tdl._BaseConsole-class.html#_bgblend
8586
tdl._BaseConsole.move tdl._BaseConsole-class.html#move
8687
tdl._BaseConsole.height tdl._BaseConsole-class.html#height
8788
tdl._BaseConsole._fg tdl._BaseConsole-class.html#_fg
@@ -110,6 +111,7 @@ tdl.Console._as_parameter_ tdl.Console-class.html#_as_parameter_
110111
tdl._BaseConsole.draw_char tdl._BaseConsole-class.html#draw_char
111112
tdl._BaseConsole.draw_frame tdl._BaseConsole-class.html#draw_frame
112113
tdl._BaseConsole.get_cursor tdl._BaseConsole-class.html#get_cursor
114+
tdl._BaseConsole._blend tdl._BaseConsole-class.html#_blend
113115
tdl._BaseConsole._normalizePoint tdl._BaseConsole-class.html#_normalizePoint
114116
tdl._BaseConsole._normalizeRect tdl._BaseConsole-class.html#_normalizeRect
115117
tdl.Console.clear tdl.Console-class.html#clear
@@ -124,7 +126,6 @@ tdl.Window tdl.Window-class.html
124126
tdl.Window.get_char tdl.Window-class.html#get_char
125127
tdl._BaseConsole.print_str tdl._BaseConsole-class.html#print_str
126128
tdl.Window._set_batch tdl.Window-class.html#_set_batch
127-
tdl._BaseConsole._bgblend tdl._BaseConsole-class.html#_bgblend
128129
tdl._BaseConsole.move tdl._BaseConsole-class.html#move
129130
tdl._BaseConsole.height tdl._BaseConsole-class.html#height
130131
tdl._BaseConsole._fg tdl._BaseConsole-class.html#_fg
@@ -150,6 +151,7 @@ tdl._BaseConsole._colorLock tdl._BaseConsole-class.html#_colorLock
150151
tdl.Window.drawRect tdl.Window-class.html#drawRect
151152
tdl.Window.draw_char tdl.Window-class.html#draw_char
152153
tdl.Window.draw_frame tdl.Window-class.html#draw_frame
154+
tdl._BaseConsole._blend tdl._BaseConsole-class.html#_blend
153155
tdl._BaseConsole._normalizeRect tdl._BaseConsole-class.html#_normalizeRect
154156
tdl.Window.clear tdl.Window-class.html#clear
155157
tdl._BaseConsole.get_size tdl._BaseConsole-class.html#get_size
@@ -163,7 +165,6 @@ tdl._BaseConsole.blit tdl._BaseConsole-class.html#blit
163165
tdl._BaseConsole tdl._BaseConsole-class.html
164166
tdl._BaseConsole.get_char tdl._BaseConsole-class.html#get_char
165167
tdl._BaseConsole.print_str tdl._BaseConsole-class.html#print_str
166-
tdl._BaseConsole._bgblend tdl._BaseConsole-class.html#_bgblend
167168
tdl._BaseConsole.move tdl._BaseConsole-class.html#move
168169
tdl._BaseConsole.height tdl._BaseConsole-class.html#height
169170
tdl._BaseConsole._fg tdl._BaseConsole-class.html#_fg
@@ -185,7 +186,9 @@ tdl._BaseConsole._colorLock tdl._BaseConsole-class.html#_colorLock
185186
tdl._BaseConsole.blit tdl._BaseConsole-class.html#blit
186187
tdl._BaseConsole.draw_char tdl._BaseConsole-class.html#draw_char
187188
tdl._BaseConsole.draw_frame tdl._BaseConsole-class.html#draw_frame
189+
tdl._BaseConsole._blend tdl._BaseConsole-class.html#_blend
188190
tdl._BaseConsole._normalizeRect tdl._BaseConsole-class.html#_normalizeRect
191+
tdl._BaseConsole.clear tdl._BaseConsole-class.html#clear
189192
tdl._BaseConsole.scroll tdl._BaseConsole-class.html#scroll
190193
tdl._BaseConsole._normalizeCursor tdl._BaseConsole-class.html#_normalizeCursor
191194
tdl._BaseConsole.get_cursor tdl._BaseConsole-class.html#get_cursor

docs/class-tree.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -162,7 +162,7 @@ <h1 class="epydoc">Class Hierarchy</h1>
162162
<tr>
163163
<td align="left" class="footer">
164164
<a href="epydoc-log.html">Generated by Epydoc
165-
3.0.1 on Sat Jun 06 23:49:37 2015</a>
165+
3.0.1 on Sat Jun 20 10:40:23 2015</a>
166166
</td>
167167
<td align="right" class="footer">
168168
<a target="mainFrame" href="http://epydoc.sourceforge.net"

docs/epydoc-log.html

Lines changed: 20 additions & 22 deletions
Large diffs are not rendered by default.

docs/epydoc.config

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,11 +7,11 @@ url: http://code.google.com/p/python-tdl/
77
# The list of modules to document. Modules can be named using
88
# dotted names, module filenames, or package directory names.
99
# This option may be repeated.
10-
modules: ../tdl
10+
modules: tdl/
1111

1212
# Write html output to the current directory
1313
output: html
14-
target: ./
14+
target: docs/
1515

1616
# Whether or not to inclue private variables. (Even if included,
1717
# private variables will be hidden by default.)
@@ -36,7 +36,7 @@ include-log: yes
3636

3737
# Don't examine in any way the modules whose dotted name match this
3838
# regular expression pattern.
39-
exclude: __\w+
39+
exclude: tdl\.(style|_?libtcod.*)
4040

4141
# If True, don't try to use colors or cursor control when doing
4242
# textual output. The default False assumes a rich text prompt

docs/help.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -255,7 +255,7 @@ <h2> The Navigation Bar </h2>
255255
<tr>
256256
<td align="left" class="footer">
257257
<a href="epydoc-log.html">Generated by Epydoc
258-
3.0.1 on Sat Jun 06 23:49:37 2015</a>
258+
3.0.1 on Sat Jun 20 10:40:23 2015</a>
259259
</td>
260260
<td align="right" class="footer">
261261
<a target="mainFrame" href="http://epydoc.sourceforge.net"

0 commit comments

Comments
 (0)