chore: modify reference

Author: yizhihenpidehou

docs/_sources/dev/easygraph-doc-source.rst.txt

@@ -29,7 +29,6 @@ Repository:
 Prerequisites
 -------------
 
-It is recommended to have conda/miniconda/anaconda installed on your machine. 
 Clone these repositories and put them inside the same directory:
 
 .. code:: bash
@@ -69,7 +68,7 @@ Build HTML from ``rst`` files
    4. run `source .env/bin/activate` to activate
    5. run `pip install -r requirements.txt` to install dependencies -->
 
--  Install dependencies in ``requirements.txt`` with the following command: ``pip install -r requirements.txt``.
+-  Install dependencies in ``requirements.txt``.
 -  Run ``make html``. The updated pages locate in ``./_build/html``.
 
 Deploy to easy-graph.github.io

docs/_sources/reference/easygraph.rst.txt

@@ -5,7 +5,7 @@ Subpackages
 -----------
 
 .. toctree::
-   :maxdepth: 2
+   :maxdepth: 3
 
    easygraph.classes
    easygraph.datapipe
@@ -18,6 +18,7 @@ Subpackages
    easygraph.readwrite
    easygraph.utils
 
+
 Submodules
 ----------
 
@@ -37,10 +38,3 @@ easygraph.exception module
    :undoc-members:
    :show-inheritance:
 
-Module contents
----------------
-
-.. automodule:: easygraph
-   :members:
-   :undoc-members:
-   :show-inheritance:

docs/_sources/reference/modules.rst.txt

@@ -2,6 +2,6 @@ easygraph
 =========
 
 .. toctree::
-   :maxdepth: 4
+   :maxdepth: 2
 
    easygraph

docs/dev/easygraph-doc-source.html

@@ -113,8 +113,7 @@ <h1>Scripts and guides for generating documentation for EasyGraph<a class="heade
 </ul>
 <section id="prerequisites">
 <h2>Prerequisites<a class="headerlink" href="#prerequisites" title="Permalink to this heading"></a></h2>
-<p>It is recommended to have conda/miniconda/anaconda installed on your machine.
-Clone these repositories and put them inside the same directory:</p>
+<p>Clone these repositories and put them inside the same directory:</p>
 <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span><span class="nv">REPOS</span><span class="o">=(</span><span class="s1">&#39;Easy-Graph&#39;</span><span class="w"> </span><span class="s1">&#39;easy-graph.github.io&#39;</span><span class="w"> </span><span class="s1">&#39;easygraph-doc-source&#39;</span><span class="o">)</span>
 <span class="k">for</span><span class="w"> </span>i<span class="w"> </span><span class="k">in</span><span class="w"> </span><span class="s2">&quot;</span><span class="si">${</span><span class="nv">REPOS</span><span class="p">[@]</span><span class="si">}</span><span class="s2">&quot;</span><span class="p">;</span><span class="w"> </span><span class="k">do</span>
 <span class="w">    </span><span class="nb">echo</span><span class="w"> </span><span class="s2">&quot;Cloning: </span><span class="nv">$i</span><span class="s2">&quot;</span>
@@ -146,7 +145,7 @@ <h2>Build HTML from <code class="docutils literal notranslate"><span class="pre"
 3. run `python3 -m venv .env` for the virtual environment
 4. run `source .env/bin/activate` to activate
 5. run `pip install -r requirements.txt` to install dependencies --><ul class="simple">
-<li><p>Install dependencies in <code class="docutils literal notranslate"><span class="pre">requirements.txt</span></code> with the following command: <code class="docutils literal notranslate"><span class="pre">pip</span> <span class="pre">install</span> <span class="pre">-r</span> <span class="pre">requirements.txt</span></code>.</p></li>
+<li><p>Install dependencies in <code class="docutils literal notranslate"><span class="pre">requirements.txt</span></code>.</p></li>
 <li><p>Run <code class="docutils literal notranslate"><span class="pre">make</span> <span class="pre">html</span></code>. The updated pages locate in <code class="docutils literal notranslate"><span class="pre">./_build/html</span></code>.</p></li>
 </ul>
 </section>

docs/genindex.html

@@ -544,13 +544,6 @@ <h2 id="E">E</h2>
 
       <ul>
         <li><a href="reference/easygraph.classes.html#easygraph.classes.hypergraph.Hypergraph.e_of_group">(easygraph.classes.hypergraph.Hypergraph method)</a>
-</li>
-      </ul></li>
-      <li>
-    easygraph
-
-      <ul>
-        <li><a href="reference/easygraph.html#module-easygraph">module</a>
 </li>
       </ul></li>
       <li>
@@ -987,15 +980,15 @@ <h2 id="E">E</h2>
         <li><a href="reference/easygraph.functions.graph_generator.html#module-easygraph.functions.graph_generator.classic">module</a>
 </li>
       </ul></li>
-  </ul></td>
-  <td style="width: 33%; vertical-align: top;"><ul>
       <li>
     easygraph.functions.graph_generator.RandomNetwork
 
       <ul>
         <li><a href="reference/easygraph.functions.graph_generator.html#module-easygraph.functions.graph_generator.RandomNetwork">module</a>
 </li>
       </ul></li>
+  </ul></td>
+  <td style="width: 33%; vertical-align: top;"><ul>
       <li>
     easygraph.functions.isolate
 
@@ -1913,8 +1906,6 @@ <h2 id="M">M</h2>
     module
 
       <ul>
-        <li><a href="reference/easygraph.html#module-easygraph">easygraph</a>
-</li>
         <li><a href="reference/easygraph.classes.html#module-easygraph.classes">easygraph.classes</a>
 </li>
         <li><a href="reference/easygraph.classes.html#module-easygraph.classes.base">easygraph.classes.base</a>

docs/objects.inv

@@ -97,7 +97,7 @@ <h1>Python Module Index</h1>
        <td><img src="_static/minus.png" class="toggler"
               id="toggle-1" style="display: none" alt="-" /></td>
        <td>
-       <a href="reference/easygraph.html#module-easygraph"><code class="xref">easygraph</code></a></td><td>
+       <code class="xref">easygraph</code></td><td>
        <em></em></td></tr>
      <tr class="cg-1">
        <td></td>

docs/py-modindex.html

@@ -22,8 +22,8 @@
     <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="easygraph.datasets package" href="easygraph.datasets.html" />
-    <link rel="prev" title="Reference" href="../reference.html" /> 
+    <link rel="next" title="easygraph.datapipe package" href="easygraph.datapipe.html" />
+    <link rel="prev" title="easygraph package" href="easygraph.html" /> 
 </head>
 
 <body class="wy-body-for-nav"> 
@@ -75,6 +75,8 @@
   <ul class="wy-breadcrumbs">
       <li><a href="../index.html" class="icon icon-home" aria-label="Home"></a></li>
           <li class="breadcrumb-item"><a href="../reference.html">Reference</a></li>
+          <li class="breadcrumb-item"><a href="modules.html">easygraph</a></li>
+          <li class="breadcrumb-item"><a href="easygraph.html">easygraph package</a></li>
       <li class="breadcrumb-item active">easygraph.classes package</li>
       <li class="wy-breadcrumbs-aside">
             <a href="../_sources/reference/easygraph.classes.rst.txt" rel="nofollow"> View page source</a>
@@ -4983,8 +4985,8 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this
            </div>
           </div>
           <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
-        <a href="../reference.html" class="btn btn-neutral float-left" title="Reference" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
-        <a href="easygraph.datasets.html" class="btn btn-neutral float-right" title="easygraph.datasets package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
+        <a href="easygraph.html" class="btn btn-neutral float-left" title="easygraph package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
+        <a href="easygraph.datapipe.html" class="btn btn-neutral float-right" title="easygraph.datapipe package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
     </div>
 
   <hr/>

docs/reference/easygraph.classes.html

@@ -75,6 +75,9 @@
   <ul class="wy-breadcrumbs">
       <li><a href="../index.html" class="icon icon-home" aria-label="Home"></a></li>
           <li class="breadcrumb-item"><a href="../reference.html">Reference</a></li>
+          <li class="breadcrumb-item"><a href="modules.html">easygraph</a></li>
+          <li class="breadcrumb-item"><a href="easygraph.html">easygraph package</a></li>
+          <li class="breadcrumb-item"><a href="easygraph.functions.html">easygraph.functions package</a></li>
       <li class="breadcrumb-item active">easygraph.functions.centrality package</li>
       <li class="wy-breadcrumbs-aside">
             <a href="../_sources/reference/easygraph.functions.centrality.rst.txt" rel="nofollow"> View page source</a>

docs/reference/easygraph.functions.centrality.html

@@ -21,7 +21,7 @@
     <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="easygraph.functions.drawing package" href="easygraph.functions.drawing.html" />
+    <link rel="next" title="easygraph.functions.core package" href="easygraph.functions.core.html" />
     <link rel="prev" title="easygraph.functions.community package" href="easygraph.functions.community.html" /> 
 </head>
 
@@ -74,6 +74,9 @@
   <ul class="wy-breadcrumbs">
       <li><a href="../index.html" class="icon icon-home" aria-label="Home"></a></li>
           <li class="breadcrumb-item"><a href="../reference.html">Reference</a></li>
+          <li class="breadcrumb-item"><a href="modules.html">easygraph</a></li>
+          <li class="breadcrumb-item"><a href="easygraph.html">easygraph package</a></li>
+          <li class="breadcrumb-item"><a href="easygraph.functions.html">easygraph.functions package</a></li>
       <li class="breadcrumb-item active">easygraph.functions.components package</li>
       <li class="wy-breadcrumbs-aside">
             <a href="../_sources/reference/easygraph.functions.components.rst.txt" rel="nofollow"> View page source</a>
@@ -519,7 +522,7 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this
           </div>
           <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
         <a href="easygraph.functions.community.html" class="btn btn-neutral float-left" title="easygraph.functions.community package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
-        <a href="easygraph.functions.drawing.html" class="btn btn-neutral float-right" title="easygraph.functions.drawing package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
+        <a href="easygraph.functions.core.html" class="btn btn-neutral float-right" title="easygraph.functions.core package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
     </div>
 
   <hr/>