add lab manuals

README.md

@@ -1,5 +1,19 @@
 # OpenNetLab Doc
 
+## overview
+
 documentation for OpenNetLab for Education 2022
 
 see [doc site](https://OpenNetLab.github.io/OpenNetLab-Edu-Doc) for more details
+
+## site generation
+
+```
+# install the required build modules
+pip3 install sphinx --user
+pip3 install sphinx_rtd_theme --user
+pip3 install myst-parser --user
+
+# make
+make html
+```

conf.py

@@ -18,11 +18,11 @@
 # -- Project information -----------------------------------------------------
 
 project = 'OpenNetLab-Edu-2022'
-copyright = '2022, zdszero'
-author = 'zdszero'
+copyright = '2022, OpenNetLab'
+author = 'OpenNetLab'
 
 # The full version, including alpha/beta/rc tags
-release = '0.2'
+release = '1.0'
 
 
 # -- General configuration ---------------------------------------------------

docs/html/.buildinfo

@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: 6e006d153d030098b15df0a7e4a7c09c
+config: 7906e0535580c730fc07d3c998b668f8
 tags: 645f666f9bcd5a90fca523b33c5a78b7

docs/html/OpenNetLab.html

@@ -4,7 +4,7 @@
   <meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>OpenNetLab package &mdash; OpenNetLab-Edu-2022 0.2 documentation</title>
+  <title>OpenNetLab package &mdash; OpenNetLab-Edu-2022 1.0 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]>
@@ -14,6 +14,7 @@
         <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/_sphinx_javascript_frameworks_compat.js"></script>
         <script src="_static/doctools.js"></script>
     <script src="_static/js/theme.js"></script>
     <link rel="index" title="Index" href="genindex.html" />
@@ -44,7 +45,7 @@
 </ul>
 <p class="caption" role="heading"><span class="caption-text">Lab Manuals:</span></p>
 <ul>
-<li class="toctree-l1"><a class="reference internal" href="onl-doc/gbn_sender_manual.html">GBN Sender Lab</a></li>
+<li class="toctree-l1"><a class="reference internal" href="lab-manuals/dns_server.html">DNS Server Lab</a></li>
 </ul>
 
         </div>
@@ -72,9 +73,9 @@
            <div itemprop="articleBody">
 
   <section id="opennetlab-package">
-<h1>OpenNetLab package<a class="headerlink" href="#opennetlab-package" title="Permalink to this headline"></a></h1>
+<h1>OpenNetLab package<a class="headerlink" href="#opennetlab-package" title="Permalink to this heading"></a></h1>
 <section id="subpackages">
-<h2>Subpackages<a class="headerlink" href="#subpackages" title="Permalink to this headline"></a></h2>
+<h2>Subpackages<a class="headerlink" href="#subpackages" title="Permalink to this heading"></a></h2>
 <div class="toctree-wrapper compound">
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="OpenNetLab.node.html">OpenNetLab.node package</a><ul>
@@ -101,7 +102,7 @@ <h2>Subpackages<a class="headerlink" href="#subpackages" title="Permalink to thi
 </div>
 </section>
 <section id="module-OpenNetLab">
-<span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-OpenNetLab" title="Permalink to this headline"></a></h2>
+<span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-OpenNetLab" title="Permalink to this heading"></a></h2>
 </section>
 </section>
 
@@ -113,7 +114,7 @@ <h2>Subpackages<a class="headerlink" href="#subpackages" title="Permalink to thi
   <hr/>
 
   <div role="contentinfo">
-    <p>&#169; Copyright 2022, zdszero.</p>
+    <p>&#169; Copyright 2022, OpenNetLab.</p>
   </div>
 
   Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a

docs/html/OpenNetLab.protocol.html

@@ -4,7 +4,7 @@
   <meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>OpenNetLab.protocol package &mdash; OpenNetLab-Edu-2022 0.2 documentation</title>
+  <title>OpenNetLab.protocol package &mdash; OpenNetLab-Edu-2022 1.0 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]>
@@ -14,6 +14,7 @@
         <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/_sphinx_javascript_frameworks_compat.js"></script>
         <script src="_static/doctools.js"></script>
     <script src="_static/js/theme.js"></script>
     <link rel="index" title="Index" href="genindex.html" />
@@ -44,7 +45,7 @@
 </ul>
 <p class="caption" role="heading"><span class="caption-text">Lab Manuals:</span></p>
 <ul>
-<li class="toctree-l1"><a class="reference internal" href="onl-doc/gbn_sender_manual.html">GBN Sender Lab</a></li>
+<li class="toctree-l1"><a class="reference internal" href="lab-manuals/dns_server.html">DNS Server Lab</a></li>
 </ul>
 
         </div>
@@ -72,15 +73,15 @@
            <div itemprop="articleBody">
 
   <section id="opennetlab-protocol-package">
-<h1>OpenNetLab.protocol package<a class="headerlink" href="#opennetlab-protocol-package" title="Permalink to this headline"></a></h1>
+<h1>OpenNetLab.protocol package<a class="headerlink" href="#opennetlab-protocol-package" title="Permalink to this heading"></a></h1>
 <section id="submodules">
-<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline"></a></h2>
+<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this heading"></a></h2>
 </section>
 <section id="module-OpenNetLab.protocol.packet">
-<span id="opennetlab-protocol-packet-module"></span><h2>OpenNetLab.protocol.packet module<a class="headerlink" href="#module-OpenNetLab.protocol.packet" title="Permalink to this headline"></a></h2>
+<span id="opennetlab-protocol-packet-module"></span><h2>OpenNetLab.protocol.packet module<a class="headerlink" href="#module-OpenNetLab.protocol.packet" title="Permalink to this heading"></a></h2>
 <dl class="py class">
 <dt class="sig sig-object py" id="OpenNetLab.protocol.packet.ONLPacket">
-<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">OpenNetLab.protocol.packet.</span></span><span class="sig-name descname"><span class="pre">ONLPacket</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">packet_type</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">payload</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#OpenNetLab.protocol.packet.ONLPacket" title="Permalink to this definition"></a></dt>
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">OpenNetLab.protocol.packet.</span></span><span class="sig-name descname"><span class="pre">ONLPacket</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">packet_type</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">payload</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">test_idx</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">-1</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#OpenNetLab.protocol.packet.ONLPacket" title="Permalink to this definition"></a></dt>
 <dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
 <dl class="py method">
 <dt class="sig sig-object py" id="OpenNetLab.protocol.packet.ONLPacket.from_bytes">
@@ -97,7 +98,7 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this
 <dl class="py class">
 <dt class="sig sig-object py" id="OpenNetLab.protocol.packet.PacketType">
 <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">OpenNetLab.protocol.packet.</span></span><span class="sig-name descname"><span class="pre">PacketType</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#OpenNetLab.protocol.packet.PacketType" title="Permalink to this definition"></a></dt>
-<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">enum.IntEnum</span></code></p>
+<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">IntEnum</span></code></p>
 <p>An enumeration.</p>
 <dl class="py attribute">
 <dt class="sig sig-object py" id="OpenNetLab.protocol.packet.PacketType.END_EXPERIMENT">
@@ -128,7 +129,55 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this
 
 </section>
 <section id="module-OpenNetLab.protocol">
-<span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-OpenNetLab.protocol" title="Permalink to this headline"></a></h2>
+<span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-OpenNetLab.protocol" title="Permalink to this heading"></a></h2>
+<dl class="py class">
+<dt class="sig sig-object py" id="OpenNetLab.protocol.ONLPacket">
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">OpenNetLab.protocol.</span></span><span class="sig-name descname"><span class="pre">ONLPacket</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">packet_type</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">payload</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">test_idx</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">-1</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#OpenNetLab.protocol.ONLPacket" title="Permalink to this definition"></a></dt>
+<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
+<dl class="py method">
+<dt class="sig sig-object py" id="OpenNetLab.protocol.ONLPacket.from_bytes">
+<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">from_bytes</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#OpenNetLab.protocol.ONLPacket.from_bytes" title="Permalink to this definition"></a></dt>
+<dd></dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="OpenNetLab.protocol.ONLPacket.to_bytes">
+<span class="sig-name descname"><span class="pre">to_bytes</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OpenNetLab.protocol.ONLPacket.to_bytes" title="Permalink to this definition"></a></dt>
+<dd></dd></dl>
+
+</dd></dl>
+
+<dl class="py class">
+<dt class="sig sig-object py" id="OpenNetLab.protocol.PacketType">
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">OpenNetLab.protocol.</span></span><span class="sig-name descname"><span class="pre">PacketType</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#OpenNetLab.protocol.PacketType" title="Permalink to this definition"></a></dt>
+<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">IntEnum</span></code></p>
+<p>An enumeration.</p>
+<dl class="py attribute">
+<dt class="sig sig-object py" id="OpenNetLab.protocol.PacketType.END_EXPERIMENT">
+<span class="sig-name descname"><span class="pre">END_EXPERIMENT</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">2</span></em><a class="headerlink" href="#OpenNetLab.protocol.PacketType.END_EXPERIMENT" title="Permalink to this definition"></a></dt>
+<dd></dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="OpenNetLab.protocol.PacketType.END_TESTCASE">
+<span class="sig-name descname"><span class="pre">END_TESTCASE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">5</span></em><a class="headerlink" href="#OpenNetLab.protocol.PacketType.END_TESTCASE" title="Permalink to this definition"></a></dt>
+<dd></dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="OpenNetLab.protocol.PacketType.EXPIREMENT_DATA">
+<span class="sig-name descname"><span class="pre">EXPIREMENT_DATA</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">3</span></em><a class="headerlink" href="#OpenNetLab.protocol.PacketType.EXPIREMENT_DATA" title="Permalink to this definition"></a></dt>
+<dd></dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="OpenNetLab.protocol.PacketType.START_EXPERIMENT">
+<span class="sig-name descname"><span class="pre">START_EXPERIMENT</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">1</span></em><a class="headerlink" href="#OpenNetLab.protocol.PacketType.START_EXPERIMENT" title="Permalink to this definition"></a></dt>
+<dd></dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="OpenNetLab.protocol.PacketType.START_TESTCASE">
+<span class="sig-name descname"><span class="pre">START_TESTCASE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">4</span></em><a class="headerlink" href="#OpenNetLab.protocol.PacketType.START_TESTCASE" title="Permalink to this definition"></a></dt>
+<dd></dd></dl>
+
+</dd></dl>
+
 </section>
 </section>
 
@@ -140,7 +189,7 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this
   <hr/>
 
   <div role="contentinfo">
-    <p>&#169; Copyright 2022, zdszero.</p>
+    <p>&#169; Copyright 2022, OpenNetLab.</p>
   </div>
 
   Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a