Skip to content

Commit ec8323a

Browse files
wgergelywgergely
committed
Update docs
1 parent a9cdfe8 commit ec8323a

File tree

13 files changed

+104
-133
lines changed

13 files changed

+104
-133
lines changed

‎docs/_modules/bookmarks/bookmarker/bookmark_editor.html‎

Lines changed: 25 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
<!doctype html>
2-
<html class="no-js">
2+
<html class="no-js" lang="en">
33
<head><meta charset="utf-8"/>
44
<meta name="viewport" content="width=device-width,initial-scale=1"/>
55
<meta name="color-scheme" content="light dark"><link rel="index" title="Index" href="../../../genindex.html" /><link rel="search" title="Search" href="../../../search.html" />
66
<link rel="canonical" href="https://bookmarks-vfx.com/_modules/bookmarks/bookmarker/bookmark_editor.html" />
77

8-
<meta name="generator" content="sphinx-4.3.2, furo 2022.09.29"/>
9-
<title>bookmarks.bookmarker.bookmark_editor - Bookmarks 0.7.4 documentation</title>
8+
<!-- Generated with Sphinx 6.1.2 and Furo 2022.12.07 -->
9+
<title>bookmarks.bookmarker.bookmark_editor - Bookmarks 0.7.7 documentation</title>
1010
<link rel="stylesheet" type="text/css" href="../../../_static/pygments.css" />
11-
<link rel="stylesheet" type="text/css" href="../../../_static/styles/furo.css?digest=d81277517bee4d6b0349d71bb2661d4890b5617c" />
11+
<link rel="stylesheet" type="text/css" href="../../../_static/styles/furo.css?digest=91d0f0d1c444bdcb17a68e833c7a53903343c195" />
1212
<link rel="stylesheet" type="text/css" href="../../../_static/css/license_info.css" />
1313
<link rel="stylesheet" type="text/css" href="../../../_static/design-style.4045f2051d55cab465a707391d5b2007.min.css" />
1414
<link rel="stylesheet" type="text/css" href="../../../_static/styles/furo-extensions.css?digest=30d1aed668e5c3a91c3e3bf6a60b675221979f0e" />
@@ -160,7 +160,7 @@
160160
</label>
161161
</div>
162162
<div class="header-center">
163-
<a href="../../../index.html"><div class="brand">Bookmarks 0.7.4 documentation</div></a>
163+
<a href="../../../index.html"><div class="brand">Bookmarks 0.7.7 documentation</div></a>
164164
</div>
165165
<div class="header-right">
166166
<div class="theme-toggle-container theme-toggle-header">
@@ -187,10 +187,10 @@
187187
<img class="sidebar-logo only-dark" src="../../../_static/icon_bw.png" alt="Dark Logo"/>
188188
</div>
189189

190-
<span class="sidebar-brand-text">Bookmarks 0.7.4 documentation</span>
190+
<span class="sidebar-brand-text">Bookmarks 0.7.7 documentation</span>
191191

192192
</a><form class="sidebar-search-container" method="get" action="../../../search.html" role="search">
193-
<input class="sidebar-search" placeholder=Search name="q" aria-label="Search">
193+
<input class="sidebar-search" placeholder="Search" name="q" aria-label="Search">
194194
<input type="hidden" name="check_keywords" value="yes">
195195
<input type="hidden" name="area" value="default">
196196
</form>
@@ -333,6 +333,7 @@
333333
</li>
334334
</ul>
335335
</li>
336+
<li class="toctree-l1"><a class="reference internal" href="../../../py-modindex.html">Module Index</a></li>
336337
</ul>
337338
<p class="caption" role="heading"><span class="caption-text">Project Links</span></p>
338339
<ul>
@@ -571,7 +572,9 @@ <h1>Source code for bookmarks.bookmarker.bookmark_editor</h1><div class="highlig
571572
<span class="nd">@common</span><span class="o">.</span><span class="n">error</span>
572573
<span class="nd">@QtCore</span><span class="o">.</span><span class="n">Slot</span><span class="p">()</span>
573574
<span class="k">def</span> <span class="nf">add</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
574-
<span class="sd">&quot;&quot;&quot;Pick and add a folder as a new bookmark item.&quot;&quot;&quot;</span>
575+
<span class="sd">&quot;&quot;&quot;Pick and add a folder as a new bookmark item.</span>
576+
577+
<span class="sd"> &quot;&quot;&quot;</span>
575578
<span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">window</span><span class="p">()</span><span class="o">.</span><span class="n">server</span><span class="p">()</span> <span class="ow">or</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">window</span><span class="p">()</span><span class="o">.</span><span class="n">job</span><span class="p">():</span>
576579
<span class="k">return</span>
577580

@@ -588,8 +591,8 @@ <h1>Source code for bookmarks.bookmarker.bookmark_editor</h1><div class="highlig
588591

589592
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">window</span><span class="p">()</span><span class="o">.</span><span class="n">job_path</span><span class="p">()</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">path</span><span class="p">:</span>
590593
<span class="k">raise</span> <span class="ne">RuntimeError</span><span class="p">(</span><span class="s1">&#39;Bookmark item must be inside the current job folder.&#39;</span><span class="p">)</span>
591-
592-
<span class="k">if</span> <span class="ow">not</span> <span class="n">QtCore</span><span class="o">.</span><span class="n">QDir</span><span class="p">(</span><span class="n">path</span><span class="p">)</span><span class="o">.</span><span class="n">mkdir</span><span class="p">(</span><span class="n">common</span><span class="o">.</span><span class="n">bookmark_cache_dir</span><span class="p">):</span>
594+
<span class="nb">dir</span> <span class="o">=</span> <span class="n">QtCore</span><span class="o">.</span><span class="n">QDir</span><span class="p">(</span><span class="n">path</span><span class="p">)</span>
595+
<span class="k">if</span> <span class="ow">not</span> <span class="nb">dir</span><span class="o">.</span><span class="n">exists</span><span class="p">()</span> <span class="ow">and</span> <span class="ow">not</span> <span class="nb">dir</span><span class="o">.</span><span class="n">mkdir</span><span class="p">(</span><span class="n">common</span><span class="o">.</span><span class="n">bookmark_cache_dir</span><span class="p">):</span>
593596
<span class="k">raise</span> <span class="ne">RuntimeError</span><span class="p">(</span><span class="s1">&#39;Could not create bookmark&#39;</span><span class="p">)</span>
594597

595598
<span class="n">name</span> <span class="o">=</span> <span class="n">path</span><span class="p">[</span><span class="nb">len</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">window</span><span class="p">()</span><span class="o">.</span><span class="n">job_path</span><span class="p">())</span> <span class="o">+</span> <span class="mi">1</span><span class="p">:]</span>
@@ -603,6 +606,11 @@ <h1>Source code for bookmarks.bookmarker.bookmark_editor</h1><div class="highlig
603606
<span class="p">)</span><span class="o">.</span><span class="n">open</span><span class="p">()</span>
604607
<span class="k">return</span>
605608

609+
<span class="c1"># Add link</span>
610+
<span class="k">if</span> <span class="ow">not</span> <span class="n">common</span><span class="o">.</span><span class="n">add_link</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">window</span><span class="p">()</span><span class="o">.</span><span class="n">job_path</span><span class="p">(),</span> <span class="n">name</span><span class="p">,</span> <span class="n">section</span><span class="o">=</span><span class="s1">&#39;links/root&#39;</span><span class="p">):</span>
611+
<span class="n">log</span><span class="o">.</span><span class="n">error</span><span class="p">(</span><span class="s1">&#39;Could not add link&#39;</span><span class="p">)</span>
612+
613+
<span class="c1"># Add the QListWidgetItem</span>
606614
<span class="n">item</span> <span class="o">=</span> <span class="n">QtWidgets</span><span class="o">.</span><span class="n">QListWidgetItem</span><span class="p">()</span>
607615
<span class="n">item</span><span class="o">.</span><span class="n">setFlags</span><span class="p">(</span>
608616
<span class="n">QtCore</span><span class="o">.</span><span class="n">Qt</span><span class="o">.</span><span class="n">ItemIsEnabled</span> <span class="o">|</span>
@@ -691,18 +699,20 @@ <h1>Source code for bookmarks.bookmarker.bookmark_editor</h1><div class="highlig
691699
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_interrupt_requested</span><span class="p">:</span>
692700
<span class="k">return</span>
693701

694-
<span class="c1"># Return items stored in the link file</span>
702+
<span class="c1"># If links exist, return items stored in the link file and nothing else</span>
695703
<span class="k">if</span> <span class="n">recursion</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span>
696-
<span class="k">for</span> <span class="n">v</span> <span class="ow">in</span> <span class="n">common</span><span class="o">.</span><span class="n">get_links</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="n">section</span><span class="o">=</span><span class="s1">&#39;links/root&#39;</span><span class="p">):</span>
704+
<span class="n">links</span> <span class="o">=</span> <span class="n">common</span><span class="o">.</span><span class="n">get_links</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="n">section</span><span class="o">=</span><span class="s1">&#39;links/root&#39;</span><span class="p">)</span>
705+
<span class="k">for</span> <span class="n">v</span> <span class="ow">in</span> <span class="n">links</span><span class="p">:</span>
697706
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_interrupt_requested</span><span class="p">:</span>
698707
<span class="k">return</span>
699708
<span class="k">yield</span> <span class="n">v</span><span class="p">,</span> <span class="sa">f</span><span class="s1">&#39;</span><span class="si">{</span><span class="n">path</span><span class="si">}</span><span class="s1">/</span><span class="si">{</span><span class="n">v</span><span class="si">}</span><span class="s1">&#39;</span>
700709

710+
<span class="c1"># Otherwise parse the folder</span>
701711
<span class="n">recursion</span> <span class="o">+=</span> <span class="mi">1</span>
702712
<span class="k">if</span> <span class="n">recursion</span> <span class="o">&gt;</span> <span class="n">max_recursion</span><span class="p">:</span>
703713
<span class="k">return</span>
704714

705-
<span class="c1"># We&#39;ll let unreadable paths fail silently</span>
715+
<span class="c1"># Let unreadable paths fail silently</span>
706716
<span class="k">try</span><span class="p">:</span>
707717
<span class="n">it</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">scandir</span><span class="p">(</span><span class="n">path</span><span class="p">)</span>
708718
<span class="k">except</span><span class="p">:</span>
@@ -756,9 +766,7 @@ <h1>Source code for bookmarks.bookmarker.bookmark_editor</h1><div class="highlig
756766

757767
</div>
758768
<div class="right-details">
759-
<div class="icons">
760-
761-
</div>
769+
762770
</div>
763771
</div>
764772

@@ -771,9 +779,8 @@ <h1>Source code for bookmarks.bookmarker.bookmark_editor</h1><div class="highlig
771779
</aside>
772780
</div>
773781
</div><script data-url_root="../../../" id="documentation_options" src="../../../_static/documentation_options.js"></script>
774-
<script src="../../../_static/jquery.js"></script>
775-
<script src="../../../_static/underscore.js"></script>
776782
<script src="../../../_static/doctools.js"></script>
783+
<script src="../../../_static/sphinx_highlight.js"></script>
777784
<script src="../../../_static/scripts/furo.js"></script>
778785
<script src="../../../_static/design-tabs.js"></script>
779786
</body>

0 commit comments

Comments
 (0)