update docs

erdogant · Nov 3, 2023 · f0ccdb5 · f0ccdb5
1 parent b718e02
commit f0ccdb5
Show file tree

Hide file tree

Showing 10 changed files with 53 additions and 53 deletions.
diff --git a/docs/pages/doctrees/Edge properties.doctree b/docs/pages/doctrees/Edge properties.doctree
diff --git a/docs/pages/doctrees/Node properties.doctree b/docs/pages/doctrees/Node properties.doctree
diff --git a/docs/pages/doctrees/environment.pickle b/docs/pages/doctrees/environment.pickle
diff --git a/docs/pages/html/Edge properties.html b/docs/pages/html/Edge properties.html
@@ -217,9 +217,10 @@ <h2>Markers<a class="headerlink" href="#markers" title="Link to this heading">
 Each marker can be customized using the <code class="docutils literal notranslate"><span class="pre">edge_properties</span></code>.</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>
+
 <span class="c1"># Initialization</span>
 <span class="n">d3</span> <span class="o">=</span> <span class="n">d3graph</span><span class="p">()</span>
-<span class="c1"># Load karate example</span>
+<span class="c1"># Load bigbang example</span>
 <span class="n">adjmat</span> <span class="o">=</span> <span class="n">d3</span><span class="o">.</span><span class="n">import_example</span><span class="p">(</span><span class="s1">&#39;bigbang&#39;</span><span class="p">)</span>
 <span class="c1"># Process the adjacency matrix</span>
 <span class="n">d3</span><span class="o">.</span><span class="n">graph</span><span class="p">(</span><span class="n">adjmat</span><span class="p">)</span>
@@ -238,10 +239,10 @@ <h2>Markers<a class="headerlink" href="#markers" title="Link to this heading">
 <span class="n">d3</span><span class="o">.</span><span class="n">set_edge_properties</span><span class="p">(</span><span class="n">directed</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">marker_end</span><span class="o">=</span><span class="s1">&#39;&#39;</span><span class="p">,</span> <span class="n">label</span><span class="o">=</span><span class="s1">&#39;weight&#39;</span><span class="p">)</span>
 
 <span class="c1"># Set markers for individual edges</span>
-<span class="n">d3</span><span class="o">.</span><span class="n">edge_properties</span><span class="p">[</span><span class="s1">&#39;Penny&#39;</span><span class="p">,</span> <span class="s1">&#39;Leonard&#39;</span><span class="p">][</span><span class="s1">&#39;marker_end&#39;</span><span class="p">]</span><span class="o">=</span><span class="s1">&#39;arrow&#39;</span>
-<span class="n">d3</span><span class="o">.</span><span class="n">edge_properties</span><span class="p">[</span><span class="s1">&#39;Sheldon&#39;</span><span class="p">,</span> <span class="s1">&#39;Howard&#39;</span><span class="p">][</span><span class="s1">&#39;marker_end&#39;</span><span class="p">]</span><span class="o">=</span><span class="s1">&#39;stub&#39;</span>
-<span class="n">d3</span><span class="o">.</span><span class="n">edge_properties</span><span class="p">[</span><span class="s1">&#39;Sheldon&#39;</span><span class="p">,</span> <span class="s1">&#39;Leonard&#39;</span><span class="p">][</span><span class="s1">&#39;marker_end&#39;</span><span class="p">]</span><span class="o">=</span><span class="s1">&#39;circle&#39;</span>
-<span class="n">d3</span><span class="o">.</span><span class="n">edge_properties</span><span class="p">[</span><span class="s1">&#39;Rajesh&#39;</span><span class="p">,</span> <span class="s1">&#39;Penny&#39;</span><span class="p">][</span><span class="s1">&#39;marker_end&#39;</span><span class="p">]</span><span class="o">=</span><span class="s1">&#39;square&#39;</span>
+<span class="n">d3</span><span class="o">.</span><span class="n">edge_properties</span><span class="p">[</span><span class="s1">&#39;Leonard&#39;</span><span class="p">,</span> <span class="s1">&#39;Penny&#39;</span><span class="p">][</span><span class="s1">&#39;marker_end&#39;</span><span class="p">]</span><span class="o">=</span><span class="s1">&#39;arrow&#39;</span>
+<span class="n">d3</span><span class="o">.</span><span class="n">edge_properties</span><span class="p">[</span><span class="s1">&#39;Howard&#39;</span><span class="p">,</span> <span class="s1">&#39;Sheldon&#39;</span><span class="p">][</span><span class="s1">&#39;marker_end&#39;</span><span class="p">]</span><span class="o">=</span><span class="s1">&#39;stub&#39;</span>
+<span class="n">d3</span><span class="o">.</span><span class="n">edge_properties</span><span class="p">[</span><span class="s1">&#39;Leonard&#39;</span><span class="p">,</span> <span class="s1">&#39;Sheldon&#39;</span><span class="p">][</span><span class="s1">&#39;marker_end&#39;</span><span class="p">]</span><span class="o">=</span><span class="s1">&#39;circle&#39;</span>
+<span class="n">d3</span><span class="o">.</span><span class="n">edge_properties</span><span class="p">[</span><span class="s1">&#39;Penny&#39;</span><span class="p">,</span> <span class="s1">&#39;Rajesh&#39;</span><span class="p">][</span><span class="s1">&#39;marker_end&#39;</span><span class="p">]</span><span class="o">=</span><span class="s1">&#39;square&#39;</span>
 <span class="n">d3</span><span class="o">.</span><span class="n">show</span><span class="p">()</span>
 </pre></div>
 </div>
@@ -325,21 +326,20 @@ <h2>Edge Labels<a class="headerlink" href="#edge-labels" title="Link to this hea
 </pre></div>
 </div>
 <iframe src="https://erdogant.github.io/docs/d3blocks/edge_labels_1.html" height="400px" width="750px", frameBorder="0"></iframe><p>We will first set all label properties to None and then we will adjust two of them.</p>
-<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="c1"># Change the label properties for the first edge</span>
-<span class="n">d3</span><span class="o">.</span><span class="n">set_edge_properties</span><span class="p">(</span><span class="n">directed</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">marker_color</span><span class="o">=</span><span class="s1">&#39;#000FFF&#39;</span><span class="p">,</span> <span class="n">label</span><span class="o">=</span><span class="kc">None</span><span class="p">)</span>
-<span class="n">d3</span><span class="o">.</span><span class="n">edge_properties</span><span class="p">[</span><span class="s1">&#39;Amy&#39;</span><span class="p">,</span> <span class="s1">&#39;Bernadette&#39;</span><span class="p">][</span><span class="s1">&#39;weight_scaled&#39;</span><span class="p">]</span><span class="o">=</span><span class="mi">10</span>
-<span class="n">d3</span><span class="o">.</span><span class="n">edge_properties</span><span class="p">[</span><span class="s1">&#39;Amy&#39;</span><span class="p">,</span> <span class="s1">&#39;Bernadette&#39;</span><span class="p">][</span><span class="s1">&#39;label&#39;</span><span class="p">]</span><span class="o">=</span><span class="s1">&#39;amy-bern&#39;</span>
-<span class="n">d3</span><span class="o">.</span><span class="n">edge_properties</span><span class="p">[</span><span class="s1">&#39;Amy&#39;</span><span class="p">,</span> <span class="s1">&#39;Bernadette&#39;</span><span class="p">][</span><span class="s1">&#39;label_color&#39;</span><span class="p">]</span><span class="o">=</span><span class="s1">&#39;#000FFF&#39;</span>
-<span class="n">d3</span><span class="o">.</span><span class="n">edge_properties</span><span class="p">[</span><span class="s1">&#39;Amy&#39;</span><span class="p">,</span> <span class="s1">&#39;Bernadette&#39;</span><span class="p">][</span><span class="s1">&#39;label_fontsize&#39;</span><span class="p">]</span><span class="o">=</span><span class="mi">8</span>
-<span class="n">d3</span><span class="o">.</span><span class="n">edge_properties</span><span class="p">[</span><span class="s1">&#39;Amy&#39;</span><span class="p">,</span> <span class="s1">&#39;Bernadette&#39;</span><span class="p">][</span><span class="s1">&#39;edge_style&#39;</span><span class="p">]</span><span class="o">=</span><span class="mi">5</span>
-
-<span class="c1"># Change the label properties for the second edge</span>
-<span class="n">d3</span><span class="o">.</span><span class="n">edge_properties</span><span class="p">[</span><span class="s1">&#39;Bernadette&#39;</span><span class="p">,</span> <span class="s1">&#39;Howard&#39;</span><span class="p">][</span><span class="s1">&#39;label&#39;</span><span class="p">]</span><span class="o">=</span><span class="s1">&#39;bern-how&#39;</span>
-<span class="n">d3</span><span class="o">.</span><span class="n">edge_properties</span><span class="p">[</span><span class="s1">&#39;Bernadette&#39;</span><span class="p">,</span> <span class="s1">&#39;Howard&#39;</span><span class="p">][</span><span class="s1">&#39;label_fontsize&#39;</span><span class="p">]</span><span class="o">=</span><span class="mi">20</span>
-<span class="n">d3</span><span class="o">.</span><span class="n">edge_properties</span><span class="p">[</span><span class="s1">&#39;Bernadette&#39;</span><span class="p">,</span> <span class="s1">&#39;Howard&#39;</span><span class="p">][</span><span class="s1">&#39;label_color&#39;</span><span class="p">]</span><span class="o">=</span><span class="s1">&#39;#000000&#39;</span>
-<span class="n">d3</span><span class="o">.</span><span class="n">edge_properties</span><span class="p">[</span><span class="s1">&#39;Bernadette&#39;</span><span class="p">,</span> <span class="s1">&#39;Howard&#39;</span><span class="p">][</span><span class="s1">&#39;edge_style&#39;</span><span class="p">]</span><span class="o">=</span><span class="mi">20</span>
+<div class="highlight-python notranslate"><div class="highlight"><pre><span></span>    <span class="c1"># Change the label properties for the first edge</span>
+<span class="n">d3</span><span class="o">.</span><span class="n">edge_properties</span><span class="p">[</span><span class="s1">&#39;Bernadette&#39;</span><span class="p">,</span> <span class="s1">&#39;Amy&#39;</span><span class="p">][</span><span class="s1">&#39;weight_scaled&#39;</span><span class="p">]</span><span class="o">=</span><span class="mi">10</span>
+<span class="n">d3</span><span class="o">.</span><span class="n">edge_properties</span><span class="p">[</span><span class="s1">&#39;Bernadette&#39;</span><span class="p">,</span> <span class="s1">&#39;Amy&#39;</span><span class="p">][</span><span class="s1">&#39;label&#39;</span><span class="p">]</span><span class="o">=</span><span class="s1">&#39;amy-bern&#39;</span>
+<span class="n">d3</span><span class="o">.</span><span class="n">edge_properties</span><span class="p">[</span><span class="s1">&#39;Bernadette&#39;</span><span class="p">,</span> <span class="s1">&#39;Amy&#39;</span><span class="p">][</span><span class="s1">&#39;label_color&#39;</span><span class="p">]</span><span class="o">=</span><span class="s1">&#39;#000FFF&#39;</span>
+<span class="n">d3</span><span class="o">.</span><span class="n">edge_properties</span><span class="p">[</span><span class="s1">&#39;Bernadette&#39;</span><span class="p">,</span> <span class="s1">&#39;Amy&#39;</span><span class="p">][</span><span class="s1">&#39;label_fontsize&#39;</span><span class="p">]</span><span class="o">=</span><span class="mi">8</span>
+<span class="n">d3</span><span class="o">.</span><span class="n">edge_properties</span><span class="p">[</span><span class="s1">&#39;Bernadette&#39;</span><span class="p">,</span> <span class="s1">&#39;Amy&#39;</span><span class="p">][</span><span class="s1">&#39;edge_style&#39;</span><span class="p">]</span><span class="o">=</span><span class="mi">2</span>
+
+    <span class="c1"># Change the label properties for the second edge</span>
+<span class="n">d3</span><span class="o">.</span><span class="n">edge_properties</span><span class="p">[</span><span class="s1">&#39;Howard&#39;</span><span class="p">,</span> <span class="s1">&#39;Bernadette&#39;</span><span class="p">][</span><span class="s1">&#39;label&#39;</span><span class="p">]</span><span class="o">=</span><span class="s1">&#39;bern-how&#39;</span>
+<span class="n">d3</span><span class="o">.</span><span class="n">edge_properties</span><span class="p">[</span><span class="s1">&#39;Howard&#39;</span><span class="p">,</span> <span class="s1">&#39;Bernadette&#39;</span><span class="p">][</span><span class="s1">&#39;label_fontsize&#39;</span><span class="p">]</span><span class="o">=</span><span class="mi">20</span>
+<span class="n">d3</span><span class="o">.</span><span class="n">edge_properties</span><span class="p">[</span><span class="s1">&#39;Howard&#39;</span><span class="p">,</span> <span class="s1">&#39;Bernadette&#39;</span><span class="p">][</span><span class="s1">&#39;label_color&#39;</span><span class="p">]</span><span class="o">=</span><span class="s1">&#39;#000000&#39;</span>
+<span class="n">d3</span><span class="o">.</span><span class="n">edge_properties</span><span class="p">[</span><span class="s1">&#39;Howard&#39;</span><span class="p">,</span> <span class="s1">&#39;Bernadette&#39;</span><span class="p">][</span><span class="s1">&#39;edge_style&#39;</span><span class="p">]</span><span class="o">=</span><span class="mi">5</span>
 
-<span class="n">d3</span><span class="o">.</span><span class="n">show</span><span class="p">()</span>
+    <span class="n">d3</span><span class="o">.</span><span class="n">show</span><span class="p">()</span>
 </pre></div>
 </div>
 <iframe src="https://erdogant.github.io/docs/d3blocks/edge_labels_2.html" height="400px" width="750px", frameBorder="0"></iframe></section>

diff --git a/docs/pages/html/Node properties.html b/docs/pages/html/Node properties.html
@@ -366,7 +366,7 @@ <h2>Customize the properties of one specific node<a class="headerlink" href="#cu
 <span class="n">d3</span><span class="o">.</span><span class="n">node_properties</span><span class="p">[</span><span class="s1">&#39;Penny&#39;</span><span class="p">][</span><span class="s1">&#39;edge_color&#39;</span><span class="p">]</span><span class="o">=</span><span class="s1">&#39;#0000ff&#39;</span> <span class="c1"># Blue</span>
 
 <span class="c1"># Customize a specific edge property</span>
-<span class="n">d3</span><span class="o">.</span><span class="n">edge_properties</span><span class="p">[</span><span class="s1">&#39;Penny&#39;</span><span class="p">,</span> <span class="s1">&#39;Leonard&#39;</span><span class="p">][</span><span class="s1">&#39;color&#39;</span><span class="p">]</span><span class="o">=</span><span class="s1">&#39;#FF0000&#39;</span> <span class="c1"># red</span>
+<span class="n">d3</span><span class="o">.</span><span class="n">edge_properties</span><span class="p">[</span><span class="s1">&#39;Leonard&#39;</span><span class="p">,</span> <span class="s1">&#39;Penny&#39;</span><span class="p">][</span><span class="s1">&#39;color&#39;</span><span class="p">]</span><span class="o">=</span><span class="s1">&#39;#FF0000&#39;</span> <span class="c1"># red</span>
 
 <span class="c1"># Print</span>
 <span class="nb">print</span><span class="p">(</span><span class="n">d3</span><span class="o">.</span><span class="n">node_properties</span><span class="p">[</span><span class="s1">&#39;Penny&#39;</span><span class="p">])</span>

diff --git a/docs/pages/html/_sources/Edge properties.rst.txt b/docs/pages/html/_sources/Edge properties.rst.txt
@@ -70,9 +70,10 @@ Each marker can be customized using the ``edge_properties``.
 
 	# Import library
 	from d3graph import d3graph
+
 	# Initialization
 	d3 = d3graph()
-	# Load karate example
+	# Load bigbang example
 	adjmat = d3.import_example('bigbang')
 	# Process the adjacency matrix
 	d3.graph(adjmat)
@@ -91,10 +92,10 @@ Each marker can be customized using the ``edge_properties``.
 	d3.set_edge_properties(directed=True, marker_end='', label='weight')
 
 	# Set markers for individual edges
-	d3.edge_properties['Penny', 'Leonard']['marker_end']='arrow'
-	d3.edge_properties['Sheldon', 'Howard']['marker_end']='stub'
-	d3.edge_properties['Sheldon', 'Leonard']['marker_end']='circle'
-	d3.edge_properties['Rajesh', 'Penny']['marker_end']='square'
+	d3.edge_properties['Leonard', 'Penny']['marker_end']='arrow'
+	d3.edge_properties['Howard', 'Sheldon']['marker_end']='stub'
+	d3.edge_properties['Leonard', 'Sheldon']['marker_end']='circle'
+	d3.edge_properties['Penny', 'Rajesh']['marker_end']='square'
 	d3.show()
 
 .. raw:: html
@@ -219,18 +220,17 @@ We will first set all label properties to None and then we will adjust two of th
 .. code:: python
 
 	# Change the label properties for the first edge
-	d3.set_edge_properties(directed=True, marker_color='#000FFF', label=None)
-	d3.edge_properties['Amy', 'Bernadette']['weight_scaled']=10
-	d3.edge_properties['Amy', 'Bernadette']['label']='amy-bern'
-	d3.edge_properties['Amy', 'Bernadette']['label_color']='#000FFF'
-	d3.edge_properties['Amy', 'Bernadette']['label_fontsize']=8
-	d3.edge_properties['Amy', 'Bernadette']['edge_style']=5
+    d3.edge_properties['Bernadette', 'Amy']['weight_scaled']=10
+    d3.edge_properties['Bernadette', 'Amy']['label']='amy-bern'
+    d3.edge_properties['Bernadette', 'Amy']['label_color']='#000FFF'
+    d3.edge_properties['Bernadette', 'Amy']['label_fontsize']=8
+    d3.edge_properties['Bernadette', 'Amy']['edge_style']=2
 
 	# Change the label properties for the second edge
-	d3.edge_properties['Bernadette', 'Howard']['label']='bern-how'
-	d3.edge_properties['Bernadette', 'Howard']['label_fontsize']=20
-	d3.edge_properties['Bernadette', 'Howard']['label_color']='#000000'
-	d3.edge_properties['Bernadette', 'Howard']['edge_style']=20
+    d3.edge_properties['Howard', 'Bernadette']['label']='bern-how'
+    d3.edge_properties['Howard', 'Bernadette']['label_fontsize']=20
+    d3.edge_properties['Howard', 'Bernadette']['label_color']='#000000'
+    d3.edge_properties['Howard', 'Bernadette']['edge_style']=5
 
 	d3.show()
 

diff --git a/docs/pages/html/_sources/Node properties.rst.txt b/docs/pages/html/_sources/Node properties.rst.txt
@@ -273,7 +273,7 @@ Customize the properties of one specific node
 	d3.node_properties['Penny']['edge_color']='#0000ff' # Blue
 
 	# Customize a specific edge property
-	d3.edge_properties['Penny', 'Leonard']['color']='#FF0000' # red
+	d3.edge_properties['Leonard', 'Penny']['color']='#FF0000' # red
 	
 	# Print
 	print(d3.node_properties['Penny'])

diff --git a/docs/pages/html/searchindex.js b/docs/pages/html/searchindex.js
diff --git a/docs/source/Edge properties.rst b/docs/source/Edge properties.rst
@@ -70,9 +70,10 @@ Each marker can be customized using the ``edge_properties``.
 
 	# Import library
 	from d3graph import d3graph
+
 	# Initialization
 	d3 = d3graph()
-	# Load karate example
+	# Load bigbang example
 	adjmat = d3.import_example('bigbang')
 	# Process the adjacency matrix
 	d3.graph(adjmat)
@@ -91,10 +92,10 @@ Each marker can be customized using the ``edge_properties``.
 	d3.set_edge_properties(directed=True, marker_end='', label='weight')
 
 	# Set markers for individual edges
-	d3.edge_properties['Penny', 'Leonard']['marker_end']='arrow'
-	d3.edge_properties['Sheldon', 'Howard']['marker_end']='stub'
-	d3.edge_properties['Sheldon', 'Leonard']['marker_end']='circle'
-	d3.edge_properties['Rajesh', 'Penny']['marker_end']='square'
+	d3.edge_properties['Leonard', 'Penny']['marker_end']='arrow'
+	d3.edge_properties['Howard', 'Sheldon']['marker_end']='stub'
+	d3.edge_properties['Leonard', 'Sheldon']['marker_end']='circle'
+	d3.edge_properties['Penny', 'Rajesh']['marker_end']='square'
 	d3.show()
 
 .. raw:: html
@@ -219,18 +220,17 @@ We will first set all label properties to None and then we will adjust two of th
 .. code:: python
 
 	# Change the label properties for the first edge
-	d3.set_edge_properties(directed=True, marker_color='#000FFF', label=None)
-	d3.edge_properties['Amy', 'Bernadette']['weight_scaled']=10
-	d3.edge_properties['Amy', 'Bernadette']['label']='amy-bern'
-	d3.edge_properties['Amy', 'Bernadette']['label_color']='#000FFF'
-	d3.edge_properties['Amy', 'Bernadette']['label_fontsize']=8
-	d3.edge_properties['Amy', 'Bernadette']['edge_style']=5
+    d3.edge_properties['Bernadette', 'Amy']['weight_scaled']=10
+    d3.edge_properties['Bernadette', 'Amy']['label']='amy-bern'
+    d3.edge_properties['Bernadette', 'Amy']['label_color']='#000FFF'
+    d3.edge_properties['Bernadette', 'Amy']['label_fontsize']=8
+    d3.edge_properties['Bernadette', 'Amy']['edge_style']=2
 
 	# Change the label properties for the second edge
-	d3.edge_properties['Bernadette', 'Howard']['label']='bern-how'
-	d3.edge_properties['Bernadette', 'Howard']['label_fontsize']=20
-	d3.edge_properties['Bernadette', 'Howard']['label_color']='#000000'
-	d3.edge_properties['Bernadette', 'Howard']['edge_style']=20
+    d3.edge_properties['Howard', 'Bernadette']['label']='bern-how'
+    d3.edge_properties['Howard', 'Bernadette']['label_fontsize']=20
+    d3.edge_properties['Howard', 'Bernadette']['label_color']='#000000'
+    d3.edge_properties['Howard', 'Bernadette']['edge_style']=5
 
 	d3.show()