update sphinx pages

erdogant · Oct 14, 2023 · 5e0b07c · 5e0b07c
1 parent 6bcdba4
commit 5e0b07c
Show file tree

Hide file tree

Showing 43 changed files with 471 additions and 284 deletions.
diff --git a/docs/pages/doctrees/Abstract.doctree b/docs/pages/doctrees/Abstract.doctree
diff --git a/docs/pages/doctrees/Coding quality.doctree b/docs/pages/doctrees/Coding quality.doctree
diff --git a/docs/pages/doctrees/Core_Functionalities.doctree b/docs/pages/doctrees/Core_Functionalities.doctree
diff --git a/docs/pages/doctrees/D3.doctree b/docs/pages/doctrees/D3.doctree
diff --git a/docs/pages/doctrees/Data.doctree b/docs/pages/doctrees/Data.doctree
diff --git a/docs/pages/doctrees/Documentation.doctree b/docs/pages/doctrees/Documentation.doctree
diff --git a/docs/pages/doctrees/Edge properties.doctree b/docs/pages/doctrees/Edge properties.doctree
diff --git a/docs/pages/doctrees/Examples.doctree b/docs/pages/doctrees/Examples.doctree
diff --git a/docs/pages/doctrees/Installation.doctree b/docs/pages/doctrees/Installation.doctree
diff --git a/docs/pages/doctrees/Node properties.doctree b/docs/pages/doctrees/Node properties.doctree
diff --git a/docs/pages/doctrees/On Click Actions.doctree b/docs/pages/doctrees/On Click Actions.doctree
diff --git a/docs/pages/doctrees/d3graph.d3graph.doctree b/docs/pages/doctrees/d3graph.d3graph.doctree
diff --git a/docs/pages/doctrees/environment.pickle b/docs/pages/doctrees/environment.pickle
diff --git a/docs/pages/doctrees/index.doctree b/docs/pages/doctrees/index.doctree
diff --git a/docs/pages/doctrees/sponsor.doctree b/docs/pages/doctrees/sponsor.doctree
diff --git a/docs/pages/html/Abstract.html b/docs/pages/html/Abstract.html
@@ -1,7 +1,7 @@
 <!DOCTYPE html>
 <html class="writer-html5" lang="en" >
 <head>
-  <meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
+  <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
   <title>Abstract &mdash; d3graph d3graph documentation</title>
@@ -12,11 +12,11 @@
     <script src="_static/js/html5shiv.min.js"></script>
   <![endif]-->
 
-        <script src="_static/jquery.js"></script>
-        <script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
-        <script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
-        <script src="_static/doctools.js"></script>
-        <script src="_static/sphinx_highlight.js"></script>
+        <script src="_static/jquery.js?v=5d32c60e"></script>
+        <script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
+        <script src="_static/documentation_options.js?v=6c61b047"></script>
+        <script src="_static/doctools.js?v=888ff710"></script>
+        <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="_static/js/theme.js"></script>
     <link rel="index" title="Index" href="genindex.html" />
     <link rel="search" title="Search" href="search.html" />
@@ -36,7 +36,7 @@
             d3graph
           </a>
               <div class="version">
-                2.4.7
+                2.4.13
               </div>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="search.html" method="get">
@@ -125,7 +125,7 @@
            <div itemprop="articleBody">
 
   <section id="abstract">
-<h1>Abstract<a class="headerlink" href="#abstract" title="Permalink to this heading"></a></h1>
+<h1>Abstract<a class="headerlink" href="#abstract" title="Link to this heading"></a></h1>
 <dl>
 <dt>Background</dt><dd><p>Visualizing your data can be the key to success in projects because it can reveal hidden insights in the data, and improve understanding. The best way to convince people is by letting them see and interact with their data. Despite many visualization packages being available in Python, it is not always straightforward to make beautiful stand-alone and interactive charts that can also work outside your own machine. The key advantage of D3 is that it works with web standards so you don’t need any other technology than a browser to make use of D3. Importantly, interactive charts can help to not just tell the reader something but let the reader see, engage, and ask questions.</p>
 </dd>
@@ -137,7 +137,7 @@ <h1>Abstract<a class="headerlink" href="#abstract" title="Permalink to this head
 </dl>
 </section>
 <section id="schematic-overview">
-<h1>Schematic overview<a class="headerlink" href="#schematic-overview" title="Permalink to this heading"></a></h1>
+<h1>Schematic overview<a class="headerlink" href="#schematic-overview" title="Link to this heading"></a></h1>
 <p>The schematic overview of our approach is as following:</p>
 <figure class="align-default" id="id1">
 <img alt="_images/schematic_overview.jpg" src="_images/schematic_overview.jpg" />

diff --git a/docs/pages/html/Coding quality.html b/docs/pages/html/Coding quality.html
@@ -1,7 +1,7 @@
 <!DOCTYPE html>
 <html class="writer-html5" lang="en" >
 <head>
-  <meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
+  <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
   <title>Coding quality &mdash; d3graph d3graph documentation</title>
@@ -12,11 +12,11 @@
     <script src="_static/js/html5shiv.min.js"></script>
   <![endif]-->
 
-        <script src="_static/jquery.js"></script>
-        <script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
-        <script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
-        <script src="_static/doctools.js"></script>
-        <script src="_static/sphinx_highlight.js"></script>
+        <script src="_static/jquery.js?v=5d32c60e"></script>
+        <script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
+        <script src="_static/documentation_options.js?v=6c61b047"></script>
+        <script src="_static/doctools.js?v=888ff710"></script>
+        <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="_static/js/theme.js"></script>
     <link rel="index" title="Index" href="genindex.html" />
     <link rel="search" title="Search" href="search.html" />
@@ -36,7 +36,7 @@
             d3graph
           </a>
               <div class="version">
-                2.4.7
+                2.4.13
               </div>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="search.html" method="get">
@@ -131,12 +131,12 @@
            <div itemprop="articleBody">
 
   <section id="coding-quality">
-<h1>Coding quality<a class="headerlink" href="#coding-quality" title="Permalink to this heading"></a></h1>
+<h1>Coding quality<a class="headerlink" href="#coding-quality" title="Link to this heading"></a></h1>
 <p>I value software quality. Higher quality software has fewer defects, better security, and better performance, which leads to happier users who can work more effectively.
 Code reviews are an effective method for improving software quality. This library is developed with several techniques, such as coding styling, low complexity, docstrings, reviews, and unit tests.
 Such conventions are helpfull to improve the quality, make the code cleaner and more understandable but alos to trace future bugs, and spot syntax errors.</p>
 <section id="library">
-<h2>library<a class="headerlink" href="#library" title="Permalink to this heading"></a></h2>
+<h2>library<a class="headerlink" href="#library" title="Link 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/d3graph/
 ├──<span class="w"> </span>.editorconfig
@@ -166,13 +166,13 @@ <h2>library<a class="headerlink" href="#library" title="Permalink to this headin
 </div>
 </section>
 <section id="style">
-<h2>Style<a class="headerlink" href="#style" title="Permalink to this heading"></a></h2>
+<h2>Style<a class="headerlink" href="#style" title="Link to this heading"></a></h2>
 <p>This library is compliant with the PEP-8 standards.
 PEP stands for Python Enhancement Proposal and sets a baseline for the readability of Python code.
 Each public function contains a docstring that is based on numpy standards.</p>
 </section>
 <section id="complexity">
-<h2>Complexity<a class="headerlink" href="#complexity" title="Permalink to this heading"></a></h2>
+<h2>Complexity<a class="headerlink" href="#complexity" title="Link to this heading"></a></h2>
 <p>This library has been developed by using measures that help decreasing technical debt.
 Version 0.1.0 of the <code class="docutils literal notranslate"><span class="pre">d3graph</span></code> library scored, according the code analyzer: <strong>VALUE</strong>, for which values &gt; 0 are good and 10 is a maximum score.
 Developing software with low(er) technical dept may take extra development time, but has many advantages:</p>
@@ -184,7 +184,7 @@ <h2>Complexity<a class="headerlink" href="#complexity" title="Permalink to this
 </ul>
 </section>
 <section id="unit-tests">
-<h2>Unit tests<a class="headerlink" href="#unit-tests" title="Permalink to this heading"></a></h2>
+<h2>Unit tests<a class="headerlink" href="#unit-tests" title="Link to this heading"></a></h2>
 <p>The use of unit tests is essential to garantee a consistent output of developed functions.
 The following tests are secured using <code class="xref py py-func docutils literal notranslate"><span class="pre">tests.test_d3graph()</span></code>:</p>
 <ul class="simple">

diff --git a/docs/pages/html/Core_Functionalities.html b/docs/pages/html/Core_Functionalities.html
@@ -1,7 +1,7 @@
 <!DOCTYPE html>
 <html class="writer-html5" lang="en" >
 <head>
-  <meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
+  <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
   <title>Core Functionalities &mdash; d3graph d3graph documentation</title>
@@ -12,11 +12,11 @@
     <script src="_static/js/html5shiv.min.js"></script>
   <![endif]-->
 
-        <script src="_static/jquery.js"></script>
-        <script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
-        <script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
-        <script src="_static/doctools.js"></script>
-        <script src="_static/sphinx_highlight.js"></script>
+        <script src="_static/jquery.js?v=5d32c60e"></script>
+        <script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
+        <script src="_static/documentation_options.js?v=6c61b047"></script>
+        <script src="_static/doctools.js?v=888ff710"></script>
+        <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="_static/js/theme.js"></script>
     <link rel="index" title="Index" href="genindex.html" />
     <link rel="search" title="Search" href="search.html" />
@@ -36,7 +36,7 @@
             d3graph
           </a>
               <div class="version">
-                2.4.7
+                2.4.13
               </div>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="search.html" method="get">
@@ -132,18 +132,18 @@
            <div itemprop="articleBody">
 
   <section id="core-functionalities">
-<h1>Core Functionalities<a class="headerlink" href="#core-functionalities" title="Permalink to this heading"></a></h1>
+<h1>Core Functionalities<a class="headerlink" href="#core-functionalities" title="Link to this heading"></a></h1>
 <p>In order to create, manipulate, and study the structure, dynamics, and functions of complex networks, it is usefull to understand the various functions of <code class="docutils literal notranslate"><span class="pre">d3graph</span></code>. Here I will describe the core functionalities that can help to customize your network. In the following examples I will be using the <strong>karate</strong> network.</p>
 <section id="import">
-<h2>Import<a class="headerlink" href="#import" title="Permalink to this heading"></a></h2>
+<h2>Import<a class="headerlink" href="#import" title="Link to this heading"></a></h2>
 <p>Importing the <code class="docutils literal notranslate"><span class="pre">d3graph</span></code> library is the first step after the pip installation.</p>
 <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="c1"># Import library</span>
 <span class="kn">from</span> <span class="nn">d3graph</span> <span class="kn">import</span> <span class="n">d3graph</span>
 </pre></div>
 </div>
 </section>
 <section id="initalization">
-<h2>Initalization<a class="headerlink" href="#initalization" title="Permalink to this heading"></a></h2>
+<h2>Initalization<a class="headerlink" href="#initalization" title="Link to this heading"></a></h2>
 <p>The initialization is directly performed after importing the <code class="docutils literal notranslate"><span class="pre">d3graph</span></code> library. During the initialization, the following parameters can be set:</p>
 <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">*</span> <span class="n">collision</span>     <span class="p">:</span> <span class="mf">0.5</span>           <span class="p">:</span> <span class="n">Response</span> <span class="n">of</span> <span class="n">the</span> <span class="n">network</span><span class="o">.</span> <span class="n">Higher</span> <span class="n">means</span> <span class="n">that</span> <span class="n">more</span> <span class="n">collisions</span> <span class="n">are</span> <span class="n">prevented</span><span class="o">.</span>
 <span class="o">*</span> <span class="n">charge</span>        <span class="p">:</span> <span class="mi">250</span>           <span class="p">:</span> <span class="n">Edge</span> <span class="n">length</span> <span class="n">of</span> <span class="n">the</span> <span class="n">network</span><span class="o">.</span> <span class="n">Towards</span> <span class="n">zero</span> <span class="n">becomes</span> <span class="n">a</span> <span class="n">dense</span> <span class="n">network</span><span class="o">.</span>
@@ -194,11 +194,11 @@ <h2>Initalization<a class="headerlink" href="#initalization" title="Permalink to
 </div>
 <iframe src="https://erdogant.github.io/docs/d3graph/d3graph/karate_charge.html" height="700px" width="850px", frameBorder="0"></iframe></section>
 <section id="processing">
-<h2>Processing<a class="headerlink" href="#processing" title="Permalink to this heading"></a></h2>
+<h2>Processing<a class="headerlink" href="#processing" title="Link to this heading"></a></h2>
 <p>The graph function <a class="reference internal" href="d3graph.d3graph.html#d3graph.d3graph.d3graph.graph" title="d3graph.d3graph.d3graph.graph"><code class="xref py py-func docutils literal notranslate"><span class="pre">d3graph.d3graph.d3graph.graph()</span></code></a> processes the adjacency matrix to create a network with default <em>node properties</em> and <em>edge properties</em>. The nodes are the column and index names, and a connect edge for vertices with value larger than 0. The strenght of edges are based on the vertices values. The input for <code class="docutils literal notranslate"><span class="pre">d3graph</span></code> is the adjacency matrix.</p>
 </section>
 <section id="show">
-<h2>Show<a class="headerlink" href="#show" title="Permalink to this heading"></a></h2>
+<h2>Show<a class="headerlink" href="#show" title="Link to this heading"></a></h2>
 <p>The show function <a class="reference internal" href="d3graph.d3graph.html#d3graph.d3graph.d3graph.show" title="d3graph.d3graph.d3graph.show"><code class="xref py py-func docutils literal notranslate"><span class="pre">d3graph.d3graph.d3graph.show()</span></code></a> has several tasks.</p>
 <blockquote>
 <div><ul class="simple">
@@ -222,7 +222,7 @@ <h2>Show<a class="headerlink" href="#show" title="Permalink to this heading">
 </div></blockquote>
 </section>
 <section id="hide-slider">
-<h2>Hide Slider<a class="headerlink" href="#hide-slider" title="Permalink to this heading"></a></h2>
+<h2>Hide Slider<a class="headerlink" href="#hide-slider" title="Link to this heading"></a></h2>
 <p>The slider can be hidden from the output HTML by setting the <code class="docutils literal notranslate"><span class="pre">show_slider=False</span></code> parameter.</p>
 <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">d3graph</span> <span class="kn">import</span> <span class="n">d3graph</span>