docs update

philiplb · Sep 18, 2016 · f82e658 · f82e658
1 parent c6f28b6
commit f82e658
Show file tree

Hide file tree

Showing 7 changed files with 42 additions and 125 deletions.
diff --git a/docs/html/0.10.0/_sources/manual/addons.txt b/docs/html/0.10.0/_sources/manual/addons.txt
@@ -88,6 +88,14 @@ Users
                 label: Password Salt
                 description: 'Auto populated field on user creation. Used internally.'
                 required: false
+            userRoles:
+                type: many
+                label: Roles
+                many:
+                    entity: role
+                    nameField: role
+                    thisField: user
+                    thatField: role
 
 
 Plus any more fields you need.
@@ -117,31 +125,6 @@ Roles
                 label: Role
                 required: true
 
-""""""""""""""""""""""""""
-Connecting Users and Roles
-""""""""""""""""""""""""""
-
-.. code-block:: yaml
-
-    userRole:
-        label: User Roles
-        table: userRole
-        fields:
-            user:
-                type: reference
-                label: User
-                reference:
-                    nameField: username
-                    entity: user
-                required: true
-            role:
-                type: reference
-                label: Role
-                reference:
-                    nameField: role
-                    entity: role
-                required: true
-
 ^^^^^^^^^^^^^^
 Password Reset
 ^^^^^^^^^^^^^^

diff --git a/docs/html/0.10.0/manual/addons.html b/docs/html/0.10.0/manual/addons.html
@@ -99,7 +99,6 @@
 <li class="toctree-l3"><a class="reference internal" href="#the-admin-panel">The Admin Panel</a><ul>
 <li class="toctree-l4"><a class="reference internal" href="#users">Users</a></li>
 <li class="toctree-l4"><a class="reference internal" href="#roles">Roles</a></li>
-<li class="toctree-l4"><a class="reference internal" href="#connecting-users-and-roles">Connecting Users and Roles</a></li>
 </ul>
 </li>
 <li class="toctree-l3"><a class="reference internal" href="#password-reset">Password Reset</a></li>
@@ -239,6 +238,14 @@ <h4>Users<a class="headerlink" href="#users" title="Permalink to this headline">
             <span class="l l-Scalar l-Scalar-Plain">label</span><span class="p p-Indicator">:</span> <span class="l l-Scalar l-Scalar-Plain">Password Salt</span>
             <span class="l l-Scalar l-Scalar-Plain">description</span><span class="p p-Indicator">:</span> <span class="s">&#39;Auto</span><span class="nv"> </span><span class="s">populated</span><span class="nv"> </span><span class="s">field</span><span class="nv"> </span><span class="s">on</span><span class="nv"> </span><span class="s">user</span><span class="nv"> </span><span class="s">creation.</span><span class="nv"> </span><span class="s">Used</span><span class="nv"> </span><span class="s">internally.&#39;</span>
             <span class="l l-Scalar l-Scalar-Plain">required</span><span class="p p-Indicator">:</span> <span class="l l-Scalar l-Scalar-Plain">false</span>
+        <span class="l l-Scalar l-Scalar-Plain">userRoles</span><span class="p p-Indicator">:</span>
+            <span class="l l-Scalar l-Scalar-Plain">type</span><span class="p p-Indicator">:</span> <span class="l l-Scalar l-Scalar-Plain">many</span>
+            <span class="l l-Scalar l-Scalar-Plain">label</span><span class="p p-Indicator">:</span> <span class="l l-Scalar l-Scalar-Plain">Roles</span>
+            <span class="l l-Scalar l-Scalar-Plain">many</span><span class="p p-Indicator">:</span>
+                <span class="l l-Scalar l-Scalar-Plain">entity</span><span class="p p-Indicator">:</span> <span class="l l-Scalar l-Scalar-Plain">role</span>
+                <span class="l l-Scalar l-Scalar-Plain">nameField</span><span class="p p-Indicator">:</span> <span class="l l-Scalar l-Scalar-Plain">role</span>
+                <span class="l l-Scalar l-Scalar-Plain">thisField</span><span class="p p-Indicator">:</span> <span class="l l-Scalar l-Scalar-Plain">user</span>
+                <span class="l l-Scalar l-Scalar-Plain">thatField</span><span class="p p-Indicator">:</span> <span class="l l-Scalar l-Scalar-Plain">role</span>
 </pre></div>
 </div>
 <p>Plus any more fields you need.</p>
@@ -264,29 +271,6 @@ <h4>Roles<a class="headerlink" href="#roles" title="Permalink to this headline">
 </pre></div>
 </div>
 </div>
-<div class="section" id="connecting-users-and-roles">
-<h4>Connecting Users and Roles<a class="headerlink" href="#connecting-users-and-roles" title="Permalink to this headline">¶</a></h4>
-<div class="highlight-yaml"><div class="highlight"><pre><span></span><span class="l l-Scalar l-Scalar-Plain">userRole</span><span class="p p-Indicator">:</span>
-    <span class="l l-Scalar l-Scalar-Plain">label</span><span class="p p-Indicator">:</span> <span class="l l-Scalar l-Scalar-Plain">User Roles</span>
-    <span class="l l-Scalar l-Scalar-Plain">table</span><span class="p p-Indicator">:</span> <span class="l l-Scalar l-Scalar-Plain">userRole</span>
-    <span class="l l-Scalar l-Scalar-Plain">fields</span><span class="p p-Indicator">:</span>
-        <span class="l l-Scalar l-Scalar-Plain">user</span><span class="p p-Indicator">:</span>
-            <span class="l l-Scalar l-Scalar-Plain">type</span><span class="p p-Indicator">:</span> <span class="l l-Scalar l-Scalar-Plain">reference</span>
-            <span class="l l-Scalar l-Scalar-Plain">label</span><span class="p p-Indicator">:</span> <span class="l l-Scalar l-Scalar-Plain">User</span>
-            <span class="l l-Scalar l-Scalar-Plain">reference</span><span class="p p-Indicator">:</span>
-                <span class="l l-Scalar l-Scalar-Plain">nameField</span><span class="p p-Indicator">:</span> <span class="l l-Scalar l-Scalar-Plain">username</span>
-                <span class="l l-Scalar l-Scalar-Plain">entity</span><span class="p p-Indicator">:</span> <span class="l l-Scalar l-Scalar-Plain">user</span>
-            <span class="l l-Scalar l-Scalar-Plain">required</span><span class="p p-Indicator">:</span> <span class="l l-Scalar l-Scalar-Plain">true</span>
-        <span class="l l-Scalar l-Scalar-Plain">role</span><span class="p p-Indicator">:</span>
-            <span class="l l-Scalar l-Scalar-Plain">type</span><span class="p p-Indicator">:</span> <span class="l l-Scalar l-Scalar-Plain">reference</span>
-            <span class="l l-Scalar l-Scalar-Plain">label</span><span class="p p-Indicator">:</span> <span class="l l-Scalar l-Scalar-Plain">Role</span>
-            <span class="l l-Scalar l-Scalar-Plain">reference</span><span class="p p-Indicator">:</span>
-                <span class="l l-Scalar l-Scalar-Plain">nameField</span><span class="p p-Indicator">:</span> <span class="l l-Scalar l-Scalar-Plain">role</span>
-                <span class="l l-Scalar l-Scalar-Plain">entity</span><span class="p p-Indicator">:</span> <span class="l l-Scalar l-Scalar-Plain">role</span>
-            <span class="l l-Scalar l-Scalar-Plain">required</span><span class="p p-Indicator">:</span> <span class="l l-Scalar l-Scalar-Plain">true</span>
-</pre></div>
-</div>
-</div>
 </div>
 <div class="section" id="password-reset">
 <h3>Password Reset<a class="headerlink" href="#password-reset" title="Permalink to this headline">¶</a></h3>

diff --git a/docs/html/0.10.0/searchindex.js b/docs/html/0.10.0/searchindex.js
diff --git a/docs/html/0.11.0/_sources/manual/addons.txt b/docs/html/0.11.0/_sources/manual/addons.txt
@@ -88,6 +88,14 @@ Users
                 label: Password Salt
                 description: 'Auto populated field on user creation. Used internally.'
                 required: false
+            userRoles:
+                type: many
+                label: Roles
+                many:
+                    entity: role
+                    nameField: role
+                    thisField: user
+                    thatField: role
 
 
 Plus any more fields you need.
@@ -117,31 +125,6 @@ Roles
                 label: Role
                 required: true
 
-""""""""""""""""""""""""""
-Connecting Users and Roles
-""""""""""""""""""""""""""
-
-.. code-block:: yaml
-
-    userRole:
-        label: User Roles
-        table: userRole
-        fields:
-            user:
-                type: reference
-                label: User
-                reference:
-                    nameField: username
-                    entity: user
-                required: true
-            role:
-                type: reference
-                label: Role
-                reference:
-                    nameField: role
-                    entity: role
-                required: true
-
 ^^^^^^^^^^^^^^
 Password Reset
 ^^^^^^^^^^^^^^

diff --git a/docs/html/0.11.0/manual/addons.html b/docs/html/0.11.0/manual/addons.html
@@ -99,7 +99,6 @@
 <li class="toctree-l3"><a class="reference internal" href="#the-admin-panel">The Admin Panel</a><ul>
 <li class="toctree-l4"><a class="reference internal" href="#users">Users</a></li>
 <li class="toctree-l4"><a class="reference internal" href="#roles">Roles</a></li>
-<li class="toctree-l4"><a class="reference internal" href="#connecting-users-and-roles">Connecting Users and Roles</a></li>
 </ul>
 </li>
 <li class="toctree-l3"><a class="reference internal" href="#password-reset">Password Reset</a></li>
@@ -239,6 +238,14 @@ <h4>Users<a class="headerlink" href="#users" title="Permalink to this headline">
             <span class="l l-Scalar l-Scalar-Plain">label</span><span class="p p-Indicator">:</span> <span class="l l-Scalar l-Scalar-Plain">Password Salt</span>
             <span class="l l-Scalar l-Scalar-Plain">description</span><span class="p p-Indicator">:</span> <span class="s">&#39;Auto</span><span class="nv"> </span><span class="s">populated</span><span class="nv"> </span><span class="s">field</span><span class="nv"> </span><span class="s">on</span><span class="nv"> </span><span class="s">user</span><span class="nv"> </span><span class="s">creation.</span><span class="nv"> </span><span class="s">Used</span><span class="nv"> </span><span class="s">internally.&#39;</span>
             <span class="l l-Scalar l-Scalar-Plain">required</span><span class="p p-Indicator">:</span> <span class="l l-Scalar l-Scalar-Plain">false</span>
+        <span class="l l-Scalar l-Scalar-Plain">userRoles</span><span class="p p-Indicator">:</span>
+            <span class="l l-Scalar l-Scalar-Plain">type</span><span class="p p-Indicator">:</span> <span class="l l-Scalar l-Scalar-Plain">many</span>
+            <span class="l l-Scalar l-Scalar-Plain">label</span><span class="p p-Indicator">:</span> <span class="l l-Scalar l-Scalar-Plain">Roles</span>
+            <span class="l l-Scalar l-Scalar-Plain">many</span><span class="p p-Indicator">:</span>
+                <span class="l l-Scalar l-Scalar-Plain">entity</span><span class="p p-Indicator">:</span> <span class="l l-Scalar l-Scalar-Plain">role</span>
+                <span class="l l-Scalar l-Scalar-Plain">nameField</span><span class="p p-Indicator">:</span> <span class="l l-Scalar l-Scalar-Plain">role</span>
+                <span class="l l-Scalar l-Scalar-Plain">thisField</span><span class="p p-Indicator">:</span> <span class="l l-Scalar l-Scalar-Plain">user</span>
+                <span class="l l-Scalar l-Scalar-Plain">thatField</span><span class="p p-Indicator">:</span> <span class="l l-Scalar l-Scalar-Plain">role</span>
 </pre></div>
 </div>
 <p>Plus any more fields you need.</p>
@@ -264,29 +271,6 @@ <h4>Roles<a class="headerlink" href="#roles" title="Permalink to this headline">
 </pre></div>
 </div>
 </div>
-<div class="section" id="connecting-users-and-roles">
-<h4>Connecting Users and Roles<a class="headerlink" href="#connecting-users-and-roles" title="Permalink to this headline">¶</a></h4>
-<div class="highlight-yaml"><div class="highlight"><pre><span></span><span class="l l-Scalar l-Scalar-Plain">userRole</span><span class="p p-Indicator">:</span>
-    <span class="l l-Scalar l-Scalar-Plain">label</span><span class="p p-Indicator">:</span> <span class="l l-Scalar l-Scalar-Plain">User Roles</span>
-    <span class="l l-Scalar l-Scalar-Plain">table</span><span class="p p-Indicator">:</span> <span class="l l-Scalar l-Scalar-Plain">userRole</span>
-    <span class="l l-Scalar l-Scalar-Plain">fields</span><span class="p p-Indicator">:</span>
-        <span class="l l-Scalar l-Scalar-Plain">user</span><span class="p p-Indicator">:</span>
-            <span class="l l-Scalar l-Scalar-Plain">type</span><span class="p p-Indicator">:</span> <span class="l l-Scalar l-Scalar-Plain">reference</span>
-            <span class="l l-Scalar l-Scalar-Plain">label</span><span class="p p-Indicator">:</span> <span class="l l-Scalar l-Scalar-Plain">User</span>
-            <span class="l l-Scalar l-Scalar-Plain">reference</span><span class="p p-Indicator">:</span>
-                <span class="l l-Scalar l-Scalar-Plain">nameField</span><span class="p p-Indicator">:</span> <span class="l l-Scalar l-Scalar-Plain">username</span>
-                <span class="l l-Scalar l-Scalar-Plain">entity</span><span class="p p-Indicator">:</span> <span class="l l-Scalar l-Scalar-Plain">user</span>
-            <span class="l l-Scalar l-Scalar-Plain">required</span><span class="p p-Indicator">:</span> <span class="l l-Scalar l-Scalar-Plain">true</span>
-        <span class="l l-Scalar l-Scalar-Plain">role</span><span class="p p-Indicator">:</span>
-            <span class="l l-Scalar l-Scalar-Plain">type</span><span class="p p-Indicator">:</span> <span class="l l-Scalar l-Scalar-Plain">reference</span>
-            <span class="l l-Scalar l-Scalar-Plain">label</span><span class="p p-Indicator">:</span> <span class="l l-Scalar l-Scalar-Plain">Role</span>
-            <span class="l l-Scalar l-Scalar-Plain">reference</span><span class="p p-Indicator">:</span>
-                <span class="l l-Scalar l-Scalar-Plain">nameField</span><span class="p p-Indicator">:</span> <span class="l l-Scalar l-Scalar-Plain">role</span>
-                <span class="l l-Scalar l-Scalar-Plain">entity</span><span class="p p-Indicator">:</span> <span class="l l-Scalar l-Scalar-Plain">role</span>
-            <span class="l l-Scalar l-Scalar-Plain">required</span><span class="p p-Indicator">:</span> <span class="l l-Scalar l-Scalar-Plain">true</span>
-</pre></div>
-</div>
-</div>
 </div>
 <div class="section" id="password-reset">
 <h3>Password Reset<a class="headerlink" href="#password-reset" title="Permalink to this headline">¶</a></h3>

diff --git a/docs/html/0.11.0/searchindex.js b/docs/html/0.11.0/searchindex.js
diff --git a/docs/manual/addons.rst b/docs/manual/addons.rst
@@ -88,6 +88,14 @@ Users
                 label: Password Salt
                 description: 'Auto populated field on user creation. Used internally.'
                 required: false
+            userRoles:
+                type: many
+                label: Roles
+                many:
+                    entity: role
+                    nameField: role
+                    thisField: user
+                    thatField: role
 
 
 Plus any more fields you need.
@@ -117,31 +125,6 @@ Roles
                 label: Role
                 required: true
 
-""""""""""""""""""""""""""
-Connecting Users and Roles
-""""""""""""""""""""""""""
-
-.. code-block:: yaml
-
-    userRole:
-        label: User Roles
-        table: userRole
-        fields:
-            user:
-                type: reference
-                label: User
-                reference:
-                    nameField: username
-                    entity: user
-                required: true
-            role:
-                type: reference
-                label: Role
-                reference:
-                    nameField: role
-                    entity: role
-                required: true
-
 ^^^^^^^^^^^^^^
 Password Reset
 ^^^^^^^^^^^^^^