Merge remote-tracking branch 'origin/topic/awelzel/zeekygen-field-directive'

* origin/topic/awelzel/zeekygen-field-directive:
  Bump doc submodule for ext/zeek.py modifications
  RecordType:DescribeReST: Render RecordType using zeek:field directive

testing/btest/Baseline/doc.zeekygen.example/example.rst

@@ -165,19 +165,28 @@ Types
 
    :Type: :zeek:type:`record`
 
-      field1: :zeek:type:`count`
-         Counts something.
 
-      field2: :zeek:type:`bool`
-         Toggles something.
+   .. zeek:field:: field1 :zeek:type:`count`
 
-      field3: :zeek:type:`ZeekygenExample::SimpleRecord`
-         Zeekygen automatically tracks types
-         and cross-references are automatically
-         inserted into generated docs.
+      Counts something.
+
+
+   .. zeek:field:: field2 :zeek:type:`bool`
+
+      Toggles something.
+
+
+   .. zeek:field:: field3 :zeek:type:`ZeekygenExample::SimpleRecord`
+
+      Zeekygen automatically tracks types
+      and cross-references are automatically
+      inserted into generated docs.
+
+
+   .. zeek:field:: msg :zeek:type:`string` :zeek:attr:`&default` = ``"blah"`` :zeek:attr:`&optional`
+
+      Attributes are self-documenting.
 
-      msg: :zeek:type:`string` :zeek:attr:`&default` = ``"blah"`` :zeek:attr:`&optional`
-         Attributes are self-documenting.
    :Attributes: :zeek:attr:`&redef`
 
    General documentation for a type "ComplexRecord" goes here.
@@ -187,11 +196,15 @@ Types
 
    :Type: :zeek:type:`record`
 
-      ts: :zeek:type:`time` :zeek:attr:`&log`
 
-      uid: :zeek:type:`string` :zeek:attr:`&log`
+   .. zeek:field:: ts :zeek:type:`time` :zeek:attr:`&log`
+
+
+   .. zeek:field:: uid :zeek:type:`string` :zeek:attr:`&log`
+
+
+   .. zeek:field:: status :zeek:type:`count` :zeek:attr:`&log` :zeek:attr:`&optional`
 
-      status: :zeek:type:`count` :zeek:attr:`&log` :zeek:attr:`&optional`
 
    An example record to be used with a logging stream.
    Nothing special about it.  If another script redefs this type
@@ -231,15 +244,22 @@ Types
 
    :Type: :zeek:type:`record`
 
-      field1: :zeek:type:`count`
-         Counts something.
 
-      field2: :zeek:type:`bool`
-         Toggles something.
+   .. zeek:field:: field1 :zeek:type:`count`
+
+      Counts something.
+
+
+   .. zeek:field:: field2 :zeek:type:`bool`
+
+      Toggles something.
+
+
+   .. zeek:field:: field_ext :zeek:type:`string` :zeek:attr:`&optional`
+
+      Document the extending field like this.
+      Or here, like this.
 
-      field_ext: :zeek:type:`string` :zeek:attr:`&optional`
-         Document the extending field like this.
-         Or here, like this.
 
    General documentation for a type "SimpleRecord" goes here.
    The way fields can be documented is similar to what's already seen

testing/btest/Baseline/doc.zeekygen.func-params/autogen-reST-func-params.rst

@@ -19,15 +19,18 @@
 
    :Type: :zeek:type:`record`
 
-      field_func: :zeek:type:`function` (i: :zeek:type:`int`, j: :zeek:type:`int`) : :zeek:type:`string`
-         This is a record field function.
-         
 
-         :param i: First param.
+   .. zeek:field:: field_func :zeek:type:`function` (i: :zeek:type:`int`, j: :zeek:type:`int`) : :zeek:type:`string`
 
-         :param j: Second param.
-         
+      This is a record field function.
+      
+
+      :param i: First param.
+
+      :param j: Second param.
+      
+
+      :returns: A string.
 
-         :returns: A string.
 
 

testing/btest/Baseline/doc.zeekygen.identifier/test.rst

@@ -102,15 +102,22 @@
 
    :Type: :zeek:type:`record`
 
-      field1: :zeek:type:`count`
-         Counts something.
 
-      field2: :zeek:type:`bool`
-         Toggles something.
+   .. zeek:field:: field1 :zeek:type:`count`
+
+      Counts something.
+
+
+   .. zeek:field:: field2 :zeek:type:`bool`
+
+      Toggles something.
+
+
+   .. zeek:field:: field_ext :zeek:type:`string` :zeek:attr:`&optional`
+
+      Document the extending field like this.
+      Or here, like this.
 
-      field_ext: :zeek:type:`string` :zeek:attr:`&optional`
-         Document the extending field like this.
-         Or here, like this.
 
    General documentation for a type "SimpleRecord" goes here.
    The way fields can be documented is similar to what's already seen
@@ -121,19 +128,28 @@
 
    :Type: :zeek:type:`record`
 
-      field1: :zeek:type:`count`
-         Counts something.
 
-      field2: :zeek:type:`bool`
-         Toggles something.
+   .. zeek:field:: field1 :zeek:type:`count`
 
-      field3: :zeek:type:`ZeekygenExample::SimpleRecord`
-         Zeekygen automatically tracks types
-         and cross-references are automatically
-         inserted into generated docs.
+      Counts something.
+
+
+   .. zeek:field:: field2 :zeek:type:`bool`
+
+      Toggles something.
+
+
+   .. zeek:field:: field3 :zeek:type:`ZeekygenExample::SimpleRecord`
+
+      Zeekygen automatically tracks types
+      and cross-references are automatically
+      inserted into generated docs.
+
+
+   .. zeek:field:: msg :zeek:type:`string` :zeek:attr:`&default` = ``"blah"`` :zeek:attr:`&optional`
+
+      Attributes are self-documenting.
 
-      msg: :zeek:type:`string` :zeek:attr:`&default` = ``"blah"`` :zeek:attr:`&optional`
-         Attributes are self-documenting.
    :Attributes: :zeek:attr:`&redef`
 
    General documentation for a type "ComplexRecord" goes here.
@@ -143,11 +159,15 @@
 
    :Type: :zeek:type:`record`
 
-      ts: :zeek:type:`time` :zeek:attr:`&log`
 
-      uid: :zeek:type:`string` :zeek:attr:`&log`
+   .. zeek:field:: ts :zeek:type:`time` :zeek:attr:`&log`
+
+
+   .. zeek:field:: uid :zeek:type:`string` :zeek:attr:`&log`
+
+
+   .. zeek:field:: status :zeek:type:`count` :zeek:attr:`&log` :zeek:attr:`&optional`
 
-      status: :zeek:type:`count` :zeek:attr:`&log` :zeek:attr:`&optional`
 
    An example record to be used with a logging stream.
    Nothing special about it.  If another script redefs this type
@@ -248,8 +268,11 @@
 
    :Type: :zeek:type:`record`
 
-      field1: :zeek:type:`bool`
 
-      field2: :zeek:type:`count`
+   .. zeek:field:: field1 :zeek:type:`bool`
+
+
+   .. zeek:field:: field2 :zeek:type:`count`
+
 
 

testing/btest/Baseline/doc.zeekygen.records/autogen-reST-records.rst

@@ -4,9 +4,12 @@
 
    :Type: :zeek:type:`record`
 
-      field1: :zeek:type:`bool`
 
-      field2: :zeek:type:`count`
+   .. zeek:field:: field1 :zeek:type:`bool`
+
+
+   .. zeek:field:: field2 :zeek:type:`count`
+
 
 
 .. zeek:type:: TestRecord2
@@ -14,18 +17,27 @@
 
    :Type: :zeek:type:`record`
 
-      A: :zeek:type:`count`
-         document ``A``
 
-      B: :zeek:type:`bool`
-         document ``B``
+   .. zeek:field:: A :zeek:type:`count`
 
-      C: :zeek:type:`TestRecord1`
-         and now ``C``
-         is a declared type
+      document ``A``
+
+
+   .. zeek:field:: B :zeek:type:`bool`
+
+      document ``B``
+
+
+   .. zeek:field:: C :zeek:type:`TestRecord1`
+
+      and now ``C``
+      is a declared type
+
+
+   .. zeek:field:: D :zeek:type:`set` [:zeek:type:`count`, :zeek:type:`bool`]
+
+      sets/tables should show the index types
 
-      D: :zeek:type:`set` [:zeek:type:`count`, :zeek:type:`bool`]
-         sets/tables should show the index types
 
    Here's the ways records and record fields can be documented.
 

testing/btest/Baseline/doc.zeekygen.type-aliases/autogen-reST-type-aliases.rst

@@ -42,10 +42,14 @@
 
    :Type: :zeek:type:`record`
 
-      f1: :zeek:type:`ZeekygenTest::TypeAlias`
 
-      f2: :zeek:type:`ZeekygenTest::OtherTypeAlias`
-
-      f3: :zeek:type:`bool`
+   .. zeek:field:: f1 :zeek:type:`ZeekygenTest::TypeAlias`
+
+
+   .. zeek:field:: f2 :zeek:type:`ZeekygenTest::OtherTypeAlias`
+
+
+   .. zeek:field:: f3 :zeek:type:`bool`
+