Переглянути джерело

docs: fix gluon-config-mode-contact-info syntax errors and formatting

Matthias Schiffer 8 роки тому
батько
коміт
b08ac98f1c
2 змінених файлів з 9 додано та 15 видалено
  1. 1 0
      docs/index.rst
  2. 8 15
      docs/package/gluon-config-mode-contact-info.rst

+ 1 - 0
docs/index.rst

@@ -52,6 +52,7 @@ Packages
    :maxdepth: 1
 
    package/gluon-client-bridge
+   package/gluon-config-mode-contact-info
    package/gluon-config-mode-geo-location
    package/gluon-ebtables-filter-multicast
    package/gluon-ebtables-filter-ra-dhcp

+ 8 - 15
docs/package/gluon-config-mode-contact-info.rst

@@ -1,28 +1,21 @@
 gluon-config-mode-contact-info
 ==============================
 
-This package allows the user to provide contact information within config mode to be 
-distributed in the mesh. You can define whether the owner contact field is 
+This package allows the user to provide contact information within config mode to be
+distributed in the mesh. You can define whether the owner contact field is
 obligatory or not in your site.conf.
 
 site.conf
 ---------
 
-config_mode.owner.obligatory : this whole section is optional
-    - ``true`` field is obligatory: gluon-node-info.@owner[0].contact may not be empty
-    - ``false`` field is optional: gluon-node-info.@owner[0].contact may be empty
-    - defaults to ``false``
+config_mode.owner.obligatory \: optional (defaults to false)
+  If ``obligatory`` is set to ``true``, the contact info field must be supplied
+  and may not be left empty.
 
-# example:
+Example::
 
   config_mode = {
-    geo_location = {
-      show_altitude = true,
-    },
     owner = {
       obligatory = true
-    },
-  },
-
-
-    
+    }
+  }