Commit 52479246c2ffadbbf35539586be87b4438432090

Authored by Nick Moran
1 parent 0e445d2b

rename ldoc readme files folder

rename ldoc configuration file
remove ldoc examples
add readme for ldoc generation
make sure tengine_doc isn't included with git
... ... @@ -11,4 +11,4 @@ out.avi
11 11 out.ogv
12 12 te4_log_web.txt
13 13 t-engine
14   -documentation/*_doc
\ No newline at end of file
  14 +tengine_doc
\ No newline at end of file
... ...
  1 +Building
  2 +========
  3 +Building the documentation requires [LDoc](https://github.com/stevedonovan/LDoc)
  4 +It has a dependency of [Penlight](https://github.com/stevedonovan/Penlight)
  5 +And optionally you can install [lua-discount](https://github.com/craigbarnes/lua-discount) for better markdown processing of comments
  6 +
  7 +Both dependencies can be found with luarocks if you have that
  8 +
  9 +Just point ldoc.lua at the directory this README file is contained in and it will handle the rest:
  10 + t-engine-source $ cd documentation
  11 + t-engine-source/documentation $ lua /path/to/ldoc.lua .
  12 +
  13 +After building the documentation, it will output into `tengine_doc` one directory below
  14 +You can alter this path by including `-d path` when calling ldoc
\ No newline at end of file
... ...
1 1 project='T-Engine 4 v1.4.0'
2 2 title='TE4 1.4.0 Documentation'
3 3 description='Documentation for T-Engine 4 - version 1.4.0'
4   -examples = {'examples'}
5   -file={'../game/engines/default/engine', '../game/engines/default/data', 'readme'}
  4 +file={'../game/engines/default/engine', '../game/engines/default/data', 'readme_files'}
6 5 kind_names={topic='Manual'}
7 6 style='!fixed'
8 7 all=true
... ... @@ -11,11 +10,11 @@ sort=false
11 10 package=engine
12 11 merge=true
13 12 format = 'discount'
14   -readme={'readme'}
  13 +readme={'readme_files'}
15 14 convert_opt=true
16 15 custom_tags={"inherit","Inherits"}
17 16 style='style'
18 17 template='style'
19   -dir='tengine_doc'
  18 +dir='../tengine_doc'
20 19 full_description=[[<a href="manual/index.md.html">View the Manual</a> | <a href="http://git.net-core.org/tome/t-engine4/">T-Engine Git Repository</a>
21 20 ]]
... ...
1   ---- Return to @{engine.Birther.newBirthDescriptor}
2   -newBirthDescriptor{
3   - type = "base",
4   - name = "base",
5   - desc = {
6   - },
7   - descriptor_choices =
8   - {
9   - world =
10   - {
11   - ["Maj'Eyal"] = "allow",
12   - Infinite = "allow",
13   - Arena = "allow",
14   - },
15   - class =
16   - {
17   - -- Specific to some races
18   - None = "disallow",
19   - },
20   - },
21   - talents = {},
22   - experience = 1.0,
23   - body = { INVEN = 1000, QS_MAINHAND = 1, QS_OFFHAND = 1, MAINHAND = 1, OFFHAND = 1, FINGER = 2, NECK = 1, LITE = 1, BODY = 1, HEAD = 1, CLOAK = 1, HANDS = 1, BELT = 1, FEET = 1, TOOL = 1, QUIVER = 1, QS_QUIVER = 1 },
24   -
25   - copy = {
26   - -- Some basic stuff
27   - move_others = true,
28   - no_auto_resists = true, no_auto_saves = true,
29   - no_auto_high_stats = true,
30   - resists_cap = {all=70},
31   - keep_inven_on_death = true,
32   - can_change_level = true,
33   - can_change_zone = true,
34   - save_hotkeys = true,
35   -
36   - -- Mages are unheard of at first, nobody but them regenerates mana
37   - mana_rating = 6,
38   - mana_regen = 0,
39   -
40   - max_level = 50,
41   - money = 15,
42   - resolvers.equip{ id=true,
43   - {type="lite", subtype="lite", name="brass lantern", ignore_material_restriction=true, ego_chance=-1000},
44   - },
45   - make_tile = function(e)
46   - if not e.image then e.image = "player/"..e.descriptor.subrace:lower():gsub("[^a-z0-9_]", "_").."_"..e.descriptor.sex:lower():gsub("[^a-z0-9_]", "_")..".png" end
47   - end,
48   - },
49   - game_state = {
50   - force_town_respec = 1,
51   - }
52   -}
\ No newline at end of file
1 1 # T-Engine 4 Manual
2 2
3 3 ## External Information
4   -* <a href="http://www.lua.org/manual/5.1/index.html">Lua 5.1 manual</a>
5   -* <a href="http://lua-users.org/wiki/LuaDirectory">Lua Users Wiki</a>
6   -* <strong>IRC:</strong> <code>irc.rizon.net #tome</code>
7   -
  4 +* <a href="http://www.lua.org/manual/5.1/index.html">Lua 5.1 manual</a>
  5 +* <a href="http://lua-users.org/wiki/LuaDirectory">Lua Users Wiki</a>
  6 +* <strong>IRC:</strong> <code>irc.rizon.net #tome</code>
8 7
9 8 ## Topics
10   -* @{colors.md|Understanding the COLOR System}
11   -
12   -## Generic Examples
13   -* @{birth_descriptor.lua|Birth Descriptor}
\ No newline at end of file
  9 +* @{colors.md|Understanding the COLOR System}
\ No newline at end of file
... ...