Add function reference

kpcyrd · Nov 20, 2018 · 9cf37f3 · 9cf37f3
1 parent af0244b
commit 9cf37f3
Showing 5 changed files with 477 additions and 5 deletions.
diff --git a/docs/database.rst b/docs/database.rst
@@ -30,7 +30,9 @@ db_add
 ------
 
 This operation is somewhat straight forward. It adds an entity to the
-database::
+database:
+
+.. code-block:: lua
 
     domain_id = db_add('domain', {
         value='example.com',
@@ -47,7 +49,9 @@ triggered and an db_update is performed instead.
 db_update
 ---------
 
-Update some mutable fields of an entity::
+Update some mutable fields of an entity:
+
+.. code-block:: lua
 
     db_update('ipaddr', arg, {
         asn=lookup['asn'],
@@ -69,7 +73,7 @@ added to the database and has not been removed from scope, this function
 returns that entities id. This is somewhat similar to ``db_add``, except that
 ``db_select`` never adds anything to the database.
 
-::
+.. code-block:: lua
 
     domain_id = db_select('domain', 'example.com')
     if domain_id ~= nil then

diff --git a/docs/index.rst b/docs/index.rst
@@ -28,3 +28,4 @@ Getting Started
    usage
    scripting
    database
+   reference
diff --git a/docs/man.rst b/docs/man.rst
@@ -10,4 +10,4 @@ todo
     :glob:
 
     usage
-    scripting
+    reference
-Original file line number
+Diff line change
@@ @@ -10,4 +10,4 @@ todo @@
         :glob:
         usage
-        scripting
+        reference