Add files via upload

aliasgar1978 · Feb 12, 2022 · 346850b · 346850b
1 parent 5cdb51a
commit 346850b
Show file tree

Hide file tree

Showing 86 changed files with 26,821 additions and 0 deletions.
diff --git a/docs/_build/html/__acg.html b/docs/_build/html/__acg.html
diff --git a/docs/_build/html/__acl.html b/docs/_build/html/__acl.html
diff --git a/docs/_build/html/__common.html b/docs/_build/html/__common.html
@@ -0,0 +1,139 @@
+<!DOCTYPE html>
+<html class="writer-html5" lang="en" >
+<head>
+  <meta charset="utf-8" />
+  <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+  <title>4.5. common &mdash; fwOper 0.0.4 documentation</title>
+      <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
+      <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
+  <!--[if lt IE 9]>
+    <script src="_static/js/html5shiv.min.js"></script>
+  <![endif]-->
+
+        <script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
+        <script src="_static/jquery.js"></script>
+        <script src="_static/underscore.js"></script>
+        <script src="_static/doctools.js"></script>
+    <script src="_static/js/theme.js"></script>
+    <link rel="index" title="Index" href="genindex.html" />
+    <link rel="search" title="Search" href="search.html" />
+    <link rel="next" title="4.6. entity" href="__entity.html" />
+    <link rel="prev" title="4.4. route" href="__route.html" /> 
+</head>
+
+<body class="wy-body-for-nav"> 
+  <div class="wy-grid-for-nav">
+    <nav data-toggle="wy-nav-shift" class="wy-nav-side">
+      <div class="wy-side-scroll">
+        <div class="wy-side-nav-search" >
+            <a href="index.html" class="icon icon-home"> fwOper
+          </a>
+<div role="search">
+  <form id="rtd-search-form" class="wy-form" action="search.html" method="get">
+    <input type="text" name="q" placeholder="Search docs" />
+    <input type="hidden" name="check_keywords" value="yes" />
+    <input type="hidden" name="area" value="default" />
+  </form>
+</div>
+        </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
+              <p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
+<ul class="current">
+<li class="toctree-l1"><a class="reference internal" href="_preface.html">1. fwOper</a></li>
+<li class="toctree-l1"><a class="reference internal" href="_install.html">2. Installation &amp; Requirements</a></li>
+<li class="toctree-l1"><a class="reference internal" href="_user_doc.html">3. User documentation!</a></li>
+<li class="toctree-l1 current"><a class="reference internal" href="_tech_doc.html">4. Technical documentation!</a><ul class="current">
+<li class="toctree-l2"><a class="reference internal" href="__acl.html">4.1. acl</a></li>
+<li class="toctree-l2"><a class="reference internal" href="__acg.html">4.2. acg</a></li>
+<li class="toctree-l2"><a class="reference internal" href="__instances.html">4.3. instances</a></li>
+<li class="toctree-l2"><a class="reference internal" href="__route.html">4.4. route</a></li>
+<li class="toctree-l2 current"><a class="current reference internal" href="#">4.5. common</a></li>
+<li class="toctree-l2"><a class="reference internal" href="__entity.html">4.6. entity</a></li>
+<li class="toctree-l2"><a class="reference internal" href="__fwObj.html">4.7. fwObj</a></li>
+<li class="toctree-l2"><a class="reference internal" href="__member.html">4.8. member</a></li>
+<li class="toctree-l2"><a class="reference internal" href="__static.html">4.9. static</a></li>
+</ul>
+</li>
+</ul>
+
+        </div>
+      </div>
+    </nav>
+
+    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
+          <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
+          <a href="index.html">fwOper</a>
+      </nav>
+
+      <div class="wy-nav-content">
+        <div class="rst-content">
+          <div role="navigation" aria-label="Page navigation">
+  <ul class="wy-breadcrumbs">
+      <li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
+          <li><a href="_tech_doc.html"><span class="section-number">4. </span>Technical documentation!</a> &raquo;</li>
+      <li><span class="section-number">4.5. </span>common</li>
+      <li class="wy-breadcrumbs-aside">
+            <a href="_sources/__common.rst.txt" rel="nofollow"> View page source</a>
+      </li>
+  </ul>
+  <hr/>
+</div>
+          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
+           <div itemprop="articleBody">
+
+  <div class="section" id="module-fwOper.common">
+<span id="common"></span><h1><span class="section-number">4.5. </span>common<a class="headerlink" href="#module-fwOper.common" title="Permalink to this headline"></a></h1>
+<dl class="py function">
+<dt class="sig sig-object py" id="fwOper.common.heading">
+<span class="sig-prename descclassname"><span class="pre">fwOper.common.</span></span><span class="sig-name descname"><span class="pre">heading</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">what</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">change</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/fwOper/common.html#heading"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#fwOper.common.heading" title="Permalink to this definition"></a></dt>
+<dd><p>used to get the Banner heading</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters</dt>
+<dd class="field-odd"><ul class="simple">
+<li><p><strong>what</strong> (<em>str</em>) – banner require for what? (valid options = acl, object-group)</p></li>
+<li><p><strong>name</strong> (<em>str</em>) – filter on valid options ( acl/object-group name )</p></li>
+<li><p><strong>change</strong> (<em>str</em>) – filter on change type ( valid options = adds, removals)</p></li>
+</ul>
+</dd>
+<dt class="field-even">Returns</dt>
+<dd class="field-even"><p>banner for the provided requirements</p>
+</dd>
+<dt class="field-odd">Return type</dt>
+<dd class="field-odd"><p>str</p>
+</dd>
+</dl>
+</dd></dl>
+
+</div>
+
+
+           </div>
+          </div>
+          <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
+        <a href="__route.html" class="btn btn-neutral float-left" title="4.4. route" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
+        <a href="__entity.html" class="btn btn-neutral float-right" title="4.6. entity" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
+    </div>
+
+  <hr/>
+
+  <div role="contentinfo">
+    <p>&#169; Copyright 2022, ALIASGAR [ALI].</p>
+  </div>
+
+  Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
+    <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
+    provided by <a href="https://readthedocs.org">Read the Docs</a>.
+
+
+</footer>
+        </div>
+      </div>
+    </section>
+  </div>
+  <script>
+      jQuery(function () {
+          SphinxRtdTheme.Navigation.enable(true);
+      });
+  </script> 
+
+</body>
+</html>