Skip to content

Commit 9bf9afd

Browse files
chore: modify reference
1 parent 907c98e commit 9bf9afd

19 files changed

Lines changed: 339 additions & 230 deletions

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

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,6 @@ Repository:
2929
Prerequisites
3030
-------------
3131

32-
It is recommended to have conda/miniconda/anaconda installed on your machine.
3332
Clone these repositories and put them inside the same directory:
3433

3534
.. code:: bash
@@ -69,7 +68,7 @@ Build HTML from ``rst`` files
6968
4. run `source .env/bin/activate` to activate
7069
5. run `pip install -r requirements.txt` to install dependencies -->
7170

72-
- Install dependencies in ``requirements.txt`` with the following command: ``pip install -r requirements.txt``.
71+
- Install dependencies in ``requirements.txt``.
7372
- Run ``make html``. The updated pages locate in ``./_build/html``.
7473

7574
Deploy to easy-graph.github.io

docs/_sources/reference/easygraph.rst.txt

Lines changed: 2 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ Subpackages
55
-----------
66

77
.. toctree::
8-
:maxdepth: 2
8+
:maxdepth: 3
99

1010
easygraph.classes
1111
easygraph.datapipe
@@ -18,6 +18,7 @@ Subpackages
1818
easygraph.readwrite
1919
easygraph.utils
2020

21+
2122
Submodules
2223
----------
2324

@@ -37,10 +38,3 @@ easygraph.exception module
3738
:undoc-members:
3839
:show-inheritance:
3940

40-
Module contents
41-
---------------
42-
43-
.. automodule:: easygraph
44-
:members:
45-
:undoc-members:
46-
:show-inheritance:

docs/_sources/reference/modules.rst.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,6 @@ easygraph
22
=========
33

44
.. toctree::
5-
:maxdepth: 4
5+
:maxdepth: 2
66

77
easygraph

docs/dev/easygraph-doc-source.html

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -113,8 +113,7 @@ <h1>Scripts and guides for generating documentation for EasyGraph<a class="heade
113113
</ul>
114114
<section id="prerequisites">
115115
<h2>Prerequisites<a class="headerlink" href="#prerequisites" title="Permalink to this heading"></a></h2>
116-
<p>It is recommended to have conda/miniconda/anaconda installed on your machine.
117-
Clone these repositories and put them inside the same directory:</p>
116+
<p>Clone these repositories and put them inside the same directory:</p>
118117
<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>
119118
<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>
120119
<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"
146145
3. run `python3 -m venv .env` for the virtual environment
147146
4. run `source .env/bin/activate` to activate
148147
5. run `pip install -r requirements.txt` to install dependencies --><ul class="simple">
149-
<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>
148+
<li><p>Install dependencies in <code class="docutils literal notranslate"><span class="pre">requirements.txt</span></code>.</p></li>
150149
<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>
151150
</ul>
152151
</section>

docs/genindex.html

Lines changed: 2 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -544,13 +544,6 @@ <h2 id="E">E</h2>
544544

545545
<ul>
546546
<li><a href="reference/easygraph.classes.html#easygraph.classes.hypergraph.Hypergraph.e_of_group">(easygraph.classes.hypergraph.Hypergraph method)</a>
547-
</li>
548-
</ul></li>
549-
<li>
550-
easygraph
551-
552-
<ul>
553-
<li><a href="reference/easygraph.html#module-easygraph">module</a>
554547
</li>
555548
</ul></li>
556549
<li>
@@ -987,15 +980,15 @@ <h2 id="E">E</h2>
987980
<li><a href="reference/easygraph.functions.graph_generator.html#module-easygraph.functions.graph_generator.classic">module</a>
988981
</li>
989982
</ul></li>
990-
</ul></td>
991-
<td style="width: 33%; vertical-align: top;"><ul>
992983
<li>
993984
easygraph.functions.graph_generator.RandomNetwork
994985

995986
<ul>
996987
<li><a href="reference/easygraph.functions.graph_generator.html#module-easygraph.functions.graph_generator.RandomNetwork">module</a>
997988
</li>
998989
</ul></li>
990+
</ul></td>
991+
<td style="width: 33%; vertical-align: top;"><ul>
999992
<li>
1000993
easygraph.functions.isolate
1001994

@@ -1913,8 +1906,6 @@ <h2 id="M">M</h2>
19131906
module
19141907

19151908
<ul>
1916-
<li><a href="reference/easygraph.html#module-easygraph">easygraph</a>
1917-
</li>
19181909
<li><a href="reference/easygraph.classes.html#module-easygraph.classes">easygraph.classes</a>
19191910
</li>
19201911
<li><a href="reference/easygraph.classes.html#module-easygraph.classes.base">easygraph.classes.base</a>

docs/objects.inv

-3 Bytes
Binary file not shown.

docs/py-modindex.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,7 @@ <h1>Python Module Index</h1>
9797
<td><img src="_static/minus.png" class="toggler"
9898
id="toggle-1" style="display: none" alt="-" /></td>
9999
<td>
100-
<a href="reference/easygraph.html#module-easygraph"><code class="xref">easygraph</code></a></td><td>
100+
<code class="xref">easygraph</code></td><td>
101101
<em></em></td></tr>
102102
<tr class="cg-1">
103103
<td></td>

docs/reference/easygraph.classes.html

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,8 @@
2222
<script src="../_static/js/theme.js"></script>
2323
<link rel="index" title="Index" href="../genindex.html" />
2424
<link rel="search" title="Search" href="../search.html" />
25-
<link rel="next" title="easygraph.datasets package" href="easygraph.datasets.html" />
26-
<link rel="prev" title="Reference" href="../reference.html" />
25+
<link rel="next" title="easygraph.datapipe package" href="easygraph.datapipe.html" />
26+
<link rel="prev" title="easygraph package" href="easygraph.html" />
2727
</head>
2828

2929
<body class="wy-body-for-nav">
@@ -75,6 +75,8 @@
7575
<ul class="wy-breadcrumbs">
7676
<li><a href="../index.html" class="icon icon-home" aria-label="Home"></a></li>
7777
<li class="breadcrumb-item"><a href="../reference.html">Reference</a></li>
78+
<li class="breadcrumb-item"><a href="modules.html">easygraph</a></li>
79+
<li class="breadcrumb-item"><a href="easygraph.html">easygraph package</a></li>
7880
<li class="breadcrumb-item active">easygraph.classes package</li>
7981
<li class="wy-breadcrumbs-aside">
8082
<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
49834985
</div>
49844986
</div>
49854987
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
4986-
<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>
4987-
<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>
4988+
<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>
4989+
<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>
49884990
</div>
49894991

49904992
<hr/>

docs/reference/easygraph.functions.centrality.html

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -75,6 +75,9 @@
7575
<ul class="wy-breadcrumbs">
7676
<li><a href="../index.html" class="icon icon-home" aria-label="Home"></a></li>
7777
<li class="breadcrumb-item"><a href="../reference.html">Reference</a></li>
78+
<li class="breadcrumb-item"><a href="modules.html">easygraph</a></li>
79+
<li class="breadcrumb-item"><a href="easygraph.html">easygraph package</a></li>
80+
<li class="breadcrumb-item"><a href="easygraph.functions.html">easygraph.functions package</a></li>
7881
<li class="breadcrumb-item active">easygraph.functions.centrality package</li>
7982
<li class="wy-breadcrumbs-aside">
8083
<a href="../_sources/reference/easygraph.functions.centrality.rst.txt" rel="nofollow"> View page source</a>

docs/reference/easygraph.functions.components.html

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121
<script src="../_static/js/theme.js"></script>
2222
<link rel="index" title="Index" href="../genindex.html" />
2323
<link rel="search" title="Search" href="../search.html" />
24-
<link rel="next" title="easygraph.functions.drawing package" href="easygraph.functions.drawing.html" />
24+
<link rel="next" title="easygraph.functions.core package" href="easygraph.functions.core.html" />
2525
<link rel="prev" title="easygraph.functions.community package" href="easygraph.functions.community.html" />
2626
</head>
2727

@@ -74,6 +74,9 @@
7474
<ul class="wy-breadcrumbs">
7575
<li><a href="../index.html" class="icon icon-home" aria-label="Home"></a></li>
7676
<li class="breadcrumb-item"><a href="../reference.html">Reference</a></li>
77+
<li class="breadcrumb-item"><a href="modules.html">easygraph</a></li>
78+
<li class="breadcrumb-item"><a href="easygraph.html">easygraph package</a></li>
79+
<li class="breadcrumb-item"><a href="easygraph.functions.html">easygraph.functions package</a></li>
7780
<li class="breadcrumb-item active">easygraph.functions.components package</li>
7881
<li class="wy-breadcrumbs-aside">
7982
<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
519522
</div>
520523
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
521524
<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>
522-
<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>
525+
<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>
523526
</div>
524527

525528
<hr/>

0 commit comments

Comments
 (0)