Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@erdogant
erdogant committed Apr 16, 2023
1 parent abeb915 commit 88e0d8a
Show file tree
Hide file tree
Showing 45 changed files with 519 additions and 13,701 deletions.
Binary file modified docs/pages/doctrees/Abstract.doctree
View file
Binary file not shown.
Binary file modified docs/pages/doctrees/Coding quality.doctree
View file
Binary file not shown.
Binary file modified docs/pages/doctrees/Documentation.doctree
View file
Binary file not shown.
Binary file modified docs/pages/doctrees/Examples.doctree
View file
Binary file not shown.
Binary file modified docs/pages/doctrees/Installation.doctree
View file
Binary file not shown.
Binary file modified docs/pages/doctrees/Methods.doctree
View file
Binary file not shown.
Binary file modified docs/pages/doctrees/Plots.doctree
View file
Binary file not shown.
Binary file modified docs/pages/doctrees/Use Cases.doctree
View file
Binary file not shown.
Binary file modified docs/pages/doctrees/environment.pickle
View file
Binary file not shown.
Binary file modified docs/pages/doctrees/hnet.hnet.doctree
View file
Binary file not shown.
Binary file modified docs/pages/doctrees/index.doctree
View file
Binary file not shown.
Binary file modified docs/pages/doctrees/input_output.doctree
View file
Binary file not shown.
Binary file modified docs/pages/doctrees/sponsor.doctree
View file
Binary file not shown.
2 changes: 1 addition & 1 deletion docs/pages/html/.buildinfo
View file
Original file line number Diff line number Diff line change
@@ -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: 76f6ed69cef8d190160654fb0e7e0478
config: f5bde51e616157337d802e1e1a1c98f0
tags: 645f666f9bcd5a90fca523b33c5a78b7
20 changes: 11 additions & 9 deletions docs/pages/html/Abstract.html
View file
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />

<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Abstract &mdash; hnet hnet documentation</title>
Expand All @@ -13,9 +13,6 @@
<![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/_sphinx_javascript_frameworks_compat.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/sphinx_highlight.js"></script>
<script src="_static/js/theme.js"></script>
Expand All @@ -30,14 +27,18 @@
<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"> hnet



<a href="index.html" class="icon icon-home">
hnet
</a>
<div class="version">
1.1.13
1.2.0
</div>
<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="text" name="q" placeholder="Search docs" aria-label="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
Expand Down Expand Up @@ -100,6 +101,7 @@
<li class="toctree-l1"><a class="reference internal" href="hnet.hnet.html#hnet.hnet.hnet"><code class="docutils literal notranslate"><span class="pre">hnet</span></code></a></li>
<li class="toctree-l1"><a class="reference internal" href="hnet.hnet.html#hnet.hnet.import_example"><code class="docutils literal notranslate"><span class="pre">import_example()</span></code></a></li>
<li class="toctree-l1"><a class="reference internal" href="hnet.hnet.html#hnet.hnet.to_undirected"><code class="docutils literal notranslate"><span class="pre">to_undirected()</span></code></a></li>
<li class="toctree-l1"><a class="reference internal" href="hnet.hnet.html#hnet.hnet.wget"><code class="docutils literal notranslate"><span class="pre">wget</span></code></a></li>
<li class="toctree-l1"><a class="reference internal" href="hnet.hnet.html#hnet.adjmat_vec.adjmat2vec"><code class="docutils literal notranslate"><span class="pre">adjmat2vec()</span></code></a></li>
<li class="toctree-l1"><a class="reference internal" href="hnet.hnet.html#hnet.adjmat_vec.vec2adjmat"><code class="docutils literal notranslate"><span class="pre">vec2adjmat()</span></code></a></li>
</ul>
Expand All @@ -119,8 +121,8 @@
<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>Abstract</li>
<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item active">Abstract</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/Abstract.rst.txt" rel="nofollow"> View page source</a>
</li>
Expand Down
70 changes: 36 additions & 34 deletions docs/pages/html/Coding quality.html
View file
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />

<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Coding quality &mdash; hnet hnet documentation</title>
Expand All @@ -13,9 +13,6 @@
<![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/_sphinx_javascript_frameworks_compat.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/sphinx_highlight.js"></script>
<script src="_static/js/theme.js"></script>
Expand All @@ -30,14 +27,18 @@
<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"> hnet



<a href="index.html" class="icon icon-home">
hnet
</a>
<div class="version">
1.1.13
1.2.0
</div>
<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="text" name="q" placeholder="Search docs" aria-label="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
Expand Down Expand Up @@ -106,6 +107,7 @@
<li class="toctree-l1"><a class="reference internal" href="hnet.hnet.html#hnet.hnet.hnet"><code class="docutils literal notranslate"><span class="pre">hnet</span></code></a></li>
<li class="toctree-l1"><a class="reference internal" href="hnet.hnet.html#hnet.hnet.import_example"><code class="docutils literal notranslate"><span class="pre">import_example()</span></code></a></li>
<li class="toctree-l1"><a class="reference internal" href="hnet.hnet.html#hnet.hnet.to_undirected"><code class="docutils literal notranslate"><span class="pre">to_undirected()</span></code></a></li>
<li class="toctree-l1"><a class="reference internal" href="hnet.hnet.html#hnet.hnet.wget"><code class="docutils literal notranslate"><span class="pre">wget</span></code></a></li>
<li class="toctree-l1"><a class="reference internal" href="hnet.hnet.html#hnet.adjmat_vec.adjmat2vec"><code class="docutils literal notranslate"><span class="pre">adjmat2vec()</span></code></a></li>
<li class="toctree-l1"><a class="reference internal" href="hnet.hnet.html#hnet.adjmat_vec.vec2adjmat"><code class="docutils literal notranslate"><span class="pre">vec2adjmat()</span></code></a></li>
</ul>
Expand All @@ -125,8 +127,8 @@
<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>Coding quality</li>
<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item active">Coding quality</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/Coding quality.rst.txt" rel="nofollow"> View page source</a>
</li>
Expand All @@ -147,24 +149,24 @@ <h1>Coding quality<a class="headerlink" href="#coding-quality" title="Permalink
<h2>library<a class="headerlink" href="#library" title="Permalink to this heading"></a></h2>
<p>The file structure of the generated package looks like:</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>path/to/hnet/
├── .gitignore
├── docs
│   ├── conf.py
│   ├── index.rst
│   └── ...
├── LICENSE
├── MANIFEST.in
├── NOTICE
├── hnet
│   ├── __init__.py
│   ├── __version__.py
│   └── hnet.py
├── README.md
├── requirements.txt
├── setup.py
└── tests
├── __init__.py
└── test_hnet.py
├──<span class="w"> </span>.gitignore
├──<span class="w"> </span>docs
│<span class="w">   </span>├──<span class="w"> </span>conf.py
│<span class="w">   </span>├──<span class="w"> </span>index.rst
│<span class="w">   </span>└──<span class="w"> </span>...
├──<span class="w"> </span>LICENSE
├──<span class="w"> </span>MANIFEST.in
├──<span class="w"> </span>NOTICE
├──<span class="w"> </span>hnet
│<span class="w">   </span>├──<span class="w"> </span>__init__.py
│<span class="w">   </span>├──<span class="w"> </span>__version__.py
│<span class="w">   </span>└──<span class="w"> </span>hnet.py
├──<span class="w"> </span>README.md
├──<span class="w"> </span>requirements.txt
├──<span class="w"> </span>setup.py
└──<span class="w"> </span>tests
<span class="w"> </span>├──<span class="w"> </span>__init__.py
<span class="w"> </span>└──<span class="w"> </span>test_hnet.py
</pre></div>
</div>
</section>
Expand Down Expand Up @@ -195,18 +197,18 @@ <h2>Unit tests<a class="headerlink" href="#unit-tests" title="Permalink to this
<li><p>The output values are checked and whether they are encoded properly.</p></li>
<li><p>The check of whether parameters are handled correctly.</p></li>
</ul>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>pytest tests<span class="se">\t</span>est_hnet.py
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>pytest<span class="w"> </span>tests<span class="se">\t</span>est_hnet.py

<span class="o">======================================</span> <span class="nb">test</span> session <span class="nv">starts</span> <span class="o">======================================</span>
platform win32 -- Python <span class="m">3</span>.6.10, pytest-5.4.0, py-1.8.1, pluggy-0.13.1
collected <span class="m">3</span> items
<span class="o">======================================</span><span class="w"> </span><span class="nb">test</span><span class="w"> </span>session<span class="w"> </span><span class="nv">starts</span><span class="w"> </span><span class="o">======================================</span>
platform<span class="w"> </span>win32<span class="w"> </span>--<span class="w"> </span>Python<span class="w"> </span><span class="m">3</span>.6.10,<span class="w"> </span>pytest-5.4.0,<span class="w"> </span>py-1.8.1,<span class="w"> </span>pluggy-0.13.1
collected<span class="w"> </span><span class="m">3</span><span class="w"> </span>items

tests<span class="se">\t</span>est_hnet.py ... <span class="o">[</span><span class="m">100</span>%<span class="o">]</span>
tests<span class="se">\t</span>est_hnet.py<span class="w"> </span>...<span class="w"> </span><span class="o">[</span><span class="m">100</span>%<span class="o">]</span>

<span class="o">=======================================</span> warnings <span class="nv">summary</span> <span class="o">========================================</span>
<span class="o">=======================================</span><span class="w"> </span>warnings<span class="w"> </span><span class="nv">summary</span><span class="w"> </span><span class="o">========================================</span>
tests/test_hnet.py::test_plot

<span class="o">===========================</span> <span class="m">3</span> passed, <span class="m">1</span> warning <span class="k">in</span> <span class="m">1254</span>.97s <span class="o">(</span><span class="m">0</span>:20:54<span class="o">)</span> <span class="o">===========================</span>
<span class="o">===========================</span><span class="w"> </span><span class="m">3</span><span class="w"> </span>passed,<span class="w"> </span><span class="m">1</span><span class="w"> </span>warning<span class="w"> </span><span class="k">in</span><span class="w"> </span><span class="m">1254</span>.97s<span class="w"> </span><span class="o">(</span><span class="m">0</span>:20:54<span class="o">)</span><span class="w"> </span><span class="o">===========================</span>
</pre></div>
</div>
<hr>
Expand Down
20 changes: 11 additions & 9 deletions docs/pages/html/Documentation.html
View file
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />

<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Sponsor &mdash; hnet hnet documentation</title>
Expand All @@ -13,9 +13,6 @@
<![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/_sphinx_javascript_frameworks_compat.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/sphinx_highlight.js"></script>
<script src="_static/js/theme.js"></script>
Expand All @@ -30,14 +27,18 @@
<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"> hnet



<a href="index.html" class="icon icon-home">
hnet
</a>
<div class="version">
1.1.13
1.2.0
</div>
<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="text" name="q" placeholder="Search docs" aria-label="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
Expand Down Expand Up @@ -100,6 +101,7 @@
<li class="toctree-l1"><a class="reference internal" href="hnet.hnet.html#hnet.hnet.hnet"><code class="docutils literal notranslate"><span class="pre">hnet</span></code></a></li>
<li class="toctree-l1"><a class="reference internal" href="hnet.hnet.html#hnet.hnet.import_example"><code class="docutils literal notranslate"><span class="pre">import_example()</span></code></a></li>
<li class="toctree-l1"><a class="reference internal" href="hnet.hnet.html#hnet.hnet.to_undirected"><code class="docutils literal notranslate"><span class="pre">to_undirected()</span></code></a></li>
<li class="toctree-l1"><a class="reference internal" href="hnet.hnet.html#hnet.hnet.wget"><code class="docutils literal notranslate"><span class="pre">wget</span></code></a></li>
<li class="toctree-l1"><a class="reference internal" href="hnet.hnet.html#hnet.adjmat_vec.adjmat2vec"><code class="docutils literal notranslate"><span class="pre">adjmat2vec()</span></code></a></li>
<li class="toctree-l1"><a class="reference internal" href="hnet.hnet.html#hnet.adjmat_vec.vec2adjmat"><code class="docutils literal notranslate"><span class="pre">vec2adjmat()</span></code></a></li>
</ul>
Expand All @@ -119,8 +121,8 @@
<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>Sponsor</li>
<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item active">Sponsor</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/Documentation.rst.txt" rel="nofollow"> View page source</a>
</li>
Expand Down
Loading

0 comments on commit 88e0d8a

Please sign in to comment.