Skip to content

Commit 64d2420

Browse files
committed
update docs
1 parent e18bf5e commit 64d2420

File tree

121 files changed

+379
-378
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

121 files changed

+379
-378
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
<img src="https://img.shields.io/badge/Python-3.8%2B-lightgrey">
88
<img src="https://img.shields.io/badge/Python-PySide2-lightgrey">
99
<img src="https://img.shields.io/badge/Platform-Windows-lightgrey">
10-
<img src="https://img.shields.io/badge/Version-v0.7.4-green">
10+
<img src="https://img.shields.io/badge/Version-v0.7.5-green">
1111
</p>
1212

1313
<p align="center">

bookmarks/__init__.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@
7373
.. |label3| image:: https://img.shields.io/badge/Platform-Windows-lightgrey
7474
:height: 18
7575
76-
.. |label4| image:: https://img.shields.io/badge/Version-v0.7.4-green
76+
.. |label4| image:: https://img.shields.io/badge/Version-v0.7.5-green
7777
:height: 18
7878
7979
.. |image1| image:: ./images/active_bookmark.png
@@ -97,7 +97,7 @@
9797
__email__ = 'hello@gergely-wootsch.com'
9898

9999
#: Project version
100-
__version__ = '0.7.4'
100+
__version__ = '0.7.5'
101101

102102
#: Project version
103103
__version_info__ = __version__.split('.')

bookmarks/maya/plugin.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
product = 'bookmarks'
1818

1919
__author__ = 'Gergely Wootsch'
20-
__version__ = '0.7.4'
20+
__version__ = '0.7.5'
2121

2222
maya_useNewAPI = True
2323

docs/.buildinfo

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
# Sphinx build info version 1
22
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
3-
config: 42f3677f5ee31f5d6c21322ee61938d7
3+
config: 22c13f22d523b4ad262792d7231fa69d
44
tags: 645f666f9bcd5a90fca523b33c5a78b7

docs/_modules/bookmarks/maya/plugin.html

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
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/maya/plugin.html" />
77

8-
<meta name="generator" content="sphinx-4.3.2, furo 2022.09.29"/>
9-
<title>bookmarks.maya.plugin - Bookmarks 0.7.4 documentation</title>
8+
<meta name="generator" content="sphinx-5.3.0, furo 2022.09.29"/>
9+
<title>bookmarks.maya.plugin - Bookmarks 0.7.5 documentation</title>
1010
<link rel="stylesheet" type="text/css" href="../../../_static/pygments.css" />
1111
<link rel="stylesheet" type="text/css" href="../../../_static/styles/furo.css?digest=d81277517bee4d6b0349d71bb2661d4890b5617c" />
1212
<link rel="stylesheet" type="text/css" href="../../../_static/css/license_info.css" />
@@ -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.5 documentation</div></a>
164164
</div>
165165
<div class="header-right">
166166
<div class="theme-toggle-container theme-toggle-header">
@@ -187,7 +187,7 @@
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.5 documentation</span>
191191

192192
</a><form class="sidebar-search-container" method="get" action="../../../search.html" role="search">
193193
<input class="sidebar-search" placeholder=Search name="q" aria-label="Search">
@@ -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>
@@ -391,7 +392,7 @@ <h1>Source code for bookmarks.maya.plugin</h1><div class="highlight"><pre>
391392
<span class="n">product</span> <span class="o">=</span> <span class="s1">&#39;bookmarks&#39;</span>
392393

393394
<span class="n">__author__</span> <span class="o">=</span> <span class="s1">&#39;Gergely Wootsch&#39;</span>
394-
<span class="n">__version__</span> <span class="o">=</span> <span class="s1">&#39;0.7.4&#39;</span>
395+
<span class="n">__version__</span> <span class="o">=</span> <span class="s1">&#39;0.7.5&#39;</span>
395396

396397
<span class="n">maya_useNewAPI</span> <span class="o">=</span> <span class="kc">True</span>
397398

@@ -538,7 +539,9 @@ <h1>Source code for bookmarks.maya.plugin</h1><div class="highlight"><pre>
538539
</div><script data-url_root="../../../" id="documentation_options" src="../../../_static/documentation_options.js"></script>
539540
<script src="../../../_static/jquery.js"></script>
540541
<script src="../../../_static/underscore.js"></script>
542+
<script src="../../../_static/_sphinx_javascript_frameworks_compat.js"></script>
541543
<script src="../../../_static/doctools.js"></script>
544+
<script src="../../../_static/sphinx_highlight.js"></script>
542545
<script src="../../../_static/scripts/furo.js"></script>
543546
<script src="../../../_static/design-tabs.js"></script>
544547
</body>

docs/_modules/index.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
<link rel="canonical" href="https://bookmarks-vfx.com/_modules/index.html" />
77

88
<meta name="generator" content="sphinx-5.3.0, furo 2022.09.29"/>
9-
<title>Overview: module code - Bookmarks 0.7.4 documentation</title>
9+
<title>Overview: module code - Bookmarks 0.7.5 documentation</title>
1010
<link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
1111
<link rel="stylesheet" type="text/css" href="../_static/styles/furo.css?digest=d81277517bee4d6b0349d71bb2661d4890b5617c" />
1212
<link rel="stylesheet" type="text/css" href="../_static/css/license_info.css" />
@@ -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.5 documentation</div></a>
164164
</div>
165165
<div class="header-right">
166166
<div class="theme-toggle-container theme-toggle-header">
@@ -187,7 +187,7 @@
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.5 documentation</span>
191191

192192
</a><form class="sidebar-search-container" method="get" action="../search.html" role="search">
193193
<input class="sidebar-search" placeholder=Search name="q" aria-label="Search">

docs/_sources/guide.rst.txt

Lines changed: 9 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ Get Bookmarks
2525

2626
The project is hosted on `Github <https://github.com/wgergely/bookmarks>`_.
2727

28-
.. admonition:: Download the latest Windows release: `Bookmarks v0.7.4 <https://github.com/wgergely/bookmarks/releases/download/0.7.4/Bookmarks_0.7.4.exe>`_
28+
.. admonition:: Download the latest Windows release: `Bookmarks v0.7.5 <https://github.com/wgergely/bookmarks/releases/download/0.7.5/Bookmarks_0.7.5.exe>`_
2929

3030
☹ Currently, Bookmarks only supports Windows.
3131

@@ -98,11 +98,11 @@ There are two ways to add bookmark items, by hand, or by editing the ``default_b
9898
.. grid:: 1
9999
:gutter: 3
100100

101-
.. grid-item-card:: 1. Add server
101+
.. grid-item-card:: 2.1. Add server
102102

103103
Click the green icon on the left-hand side. A server is usually a network location, but local folders work too. Make sure the folder exists before adding it.
104104

105-
.. grid-item-card:: 2. Select or create a job
105+
.. grid-item-card:: 2.2. Select or create a job
106106

107107
If the server already contains folders (jobs), select one here. Otherwise, click the green add icon in the middle column to create a new job.
108108

@@ -111,15 +111,15 @@ There are two ways to add bookmark items, by hand, or by editing the ``default_b
111111
You can add your own job folder templates by dragging them onto the template picker. They should be zip files containing a folder structure.
112112

113113

114-
.. grid-item-card:: 3. Select or pick new root folders
114+
.. grid-item-card:: 2.3. Select or pick new root folders
115115

116116
Select a job. If you used the default job template to create one, it comes with pre-defined root-folders (e.g. the ``data/asset``, ``data/shot`` folders). If you used a custom template, you might need to pick a new root folder by clicking the green add icon on the right-hand side.
117117

118118
.. hint::
119119

120120
Any folder with a ``.bookmark`` folder inside them will be read as a root folder. If the folder doesn't show up, you might have to change the folder parsing depth in the preferences.
121121

122-
Done! Close the editor when finished.
122+
Done! Close the editor when finished.
123123

124124

125125
How do you add new shots and assets?
@@ -199,16 +199,15 @@ How do you configure bookmark items?
199199
************************************************
200200

201201
.. card:: Bookmark property editor
202-
:class-card: sd-text-center
203202

204203
.. figure:: images/bookmark_properties2.png
205-
:width: 440
204+
:width: 480
206205

207-
To edit basic properties, like external URLs, frame rate, file-filter rules, width, and height attributes, select a bookmark item and click the settings icon, or hit ``Ctrl+E``.
206+
To edit basic properties, like external URLs, frame rate, file-filter rules, width, and height attributes, select a bookmark item and click the settings icon, or hit ``Ctrl+E``.
208207

209-
The properties will help create footage 'publishes', convert image sequences, and, using the Maya plugin, set the Maya workspace and scene settings. Linking URLs and ShotGrid entities with local files can be beneficial when the project has a lot of external resources to keep track of.
208+
The properties will help create footage 'publishes', convert image sequences, and, using the Maya plugin, set the Maya workspace and scene settings. Linking URLs and ShotGrid entities with local files can be beneficial when the project has a lot of external resources to keep track of.
210209

211-
There are also filter options to associate task folders with file formats. And more!
210+
There are also filter options to associate task folders with file formats. And more!
212211

213212

214213
Report issues

docs/_static/documentation_options.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
var DOCUMENTATION_OPTIONS = {
22
URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'),
3-
VERSION: '0.7.4',
3+
VERSION: '0.7.5',
44
LANGUAGE: 'en',
55
COLLAPSE_INDEX: false,
66
BUILDER: 'html',

docs/genindex.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
<meta name="color-scheme" content="light dark"><link rel="index" title="Index" href="#" /><link rel="search" title="Search" href="search.html" />
66
<link rel="canonical" href="https://bookmarks-vfx.com/genindex.html" />
77

8-
<meta name="generator" content="sphinx-5.3.0, furo 2022.09.29"/><title>Index - Bookmarks 0.7.4 documentation</title>
8+
<meta name="generator" content="sphinx-5.3.0, furo 2022.09.29"/><title>Index - Bookmarks 0.7.5 documentation</title>
99
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
1010
<link rel="stylesheet" type="text/css" href="_static/styles/furo.css?digest=d81277517bee4d6b0349d71bb2661d4890b5617c" />
1111
<link rel="stylesheet" type="text/css" href="_static/css/license_info.css" />
@@ -159,7 +159,7 @@
159159
</label>
160160
</div>
161161
<div class="header-center">
162-
<a href="index.html"><div class="brand">Bookmarks 0.7.4 documentation</div></a>
162+
<a href="index.html"><div class="brand">Bookmarks 0.7.5 documentation</div></a>
163163
</div>
164164
<div class="header-right">
165165
<div class="theme-toggle-container theme-toggle-header">
@@ -186,7 +186,7 @@
186186
<img class="sidebar-logo only-dark" src="_static/icon_bw.png" alt="Dark Logo"/>
187187
</div>
188188

189-
<span class="sidebar-brand-text">Bookmarks 0.7.4 documentation</span>
189+
<span class="sidebar-brand-text">Bookmarks 0.7.5 documentation</span>
190190

191191
</a><form class="sidebar-search-container" method="get" action="search.html" role="search">
192192
<input class="sidebar-search" placeholder=Search name="q" aria-label="Search">

docs/guide.html

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
<link rel="canonical" href="https://bookmarks-vfx.com/guide.html" />
99

1010
<meta name="generator" content="sphinx-5.3.0, furo 2022.09.29"/>
11-
<title>User Guide - Bookmarks 0.7.4 documentation</title>
11+
<title>User Guide - Bookmarks 0.7.5 documentation</title>
1212
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
1313
<link rel="stylesheet" type="text/css" href="_static/styles/furo.css?digest=d81277517bee4d6b0349d71bb2661d4890b5617c" />
1414
<link rel="stylesheet" type="text/css" href="_static/css/license_info.css" />
@@ -162,7 +162,7 @@
162162
</label>
163163
</div>
164164
<div class="header-center">
165-
<a href="index.html"><div class="brand">Bookmarks 0.7.4 documentation</div></a>
165+
<a href="index.html"><div class="brand">Bookmarks 0.7.5 documentation</div></a>
166166
</div>
167167
<div class="header-right">
168168
<div class="theme-toggle-container theme-toggle-header">
@@ -189,7 +189,7 @@
189189
<img class="sidebar-logo only-dark" src="_static/icon_bw.png" alt="Dark Logo"/>
190190
</div>
191191

192-
<span class="sidebar-brand-text">Bookmarks 0.7.4 documentation</span>
192+
<span class="sidebar-brand-text">Bookmarks 0.7.5 documentation</span>
193193

194194
</a><form class="sidebar-search-container" method="get" action="search.html" role="search">
195195
<input class="sidebar-search" placeholder=Search name="q" aria-label="Search">
@@ -384,8 +384,8 @@ <h1>User Guide<a class="headerlink" href="#user-guide" title="Permalink to this
384384
<div class="section" id="get-bookmarks">
385385
<h2>Get Bookmarks<a class="headerlink" href="#get-bookmarks" title="Permalink to this heading">#</a></h2>
386386
<p>The project is hosted on <a class="reference external" href="https://github.com/wgergely/bookmarks">Github</a>.</p>
387-
<div class="admonition-download-the-latest-windows-release-bookmarks-v0-7-4-https-github-com-wgergely-bookmarks-releases-download-0-7-4-bookmarks-0-7-4-exe admonition">
388-
<p class="admonition-title">Download the latest Windows release: <a class="reference external" href="https://github.com/wgergely/bookmarks/releases/download/0.7.4/Bookmarks_0.7.4.exe">Bookmarks v0.7.4</a></p>
387+
<div class="admonition-download-the-latest-windows-release-bookmarks-v0-7-5-https-github-com-wgergely-bookmarks-releases-download-0-7-5-bookmarks-0-7-5-exe admonition">
388+
<p class="admonition-title">Download the latest Windows release: <a class="reference external" href="https://github.com/wgergely/bookmarks/releases/download/0.7.5/Bookmarks_0.7.5.exe">Bookmarks v0.7.5</a></p>
389389
<p>☹ Currently, Bookmarks only supports Windows.</p>
390390
</div>
391391
</div>
@@ -449,7 +449,7 @@ <h3>How do you add bookmark items?<a class="headerlink" href="#how-do-you-add-b
449449
<div class="sd-card sd-sphinx-override sd-w-100 sd-shadow-sm docutils">
450450
<div class="sd-card-body docutils">
451451
<div class="sd-card-title sd-font-weight-bold docutils">
452-
1. Add server</div>
452+
2.1. Add server</div>
453453
<p class="sd-card-text">Click the green icon on the left-hand side. A server is usually a network location, but local folders work too. Make sure the folder exists before adding it.</p>
454454
</div>
455455
</div>
@@ -458,7 +458,7 @@ <h3>How do you add bookmark items?<a class="headerlink" href="#how-do-you-add-b
458458
<div class="sd-card sd-sphinx-override sd-w-100 sd-shadow-sm docutils">
459459
<div class="sd-card-body docutils">
460460
<div class="sd-card-title sd-font-weight-bold docutils">
461-
2. Select or create a job</div>
461+
2.2. Select or create a job</div>
462462
<p class="sd-card-text">If the server already contains folders (jobs), select one here. Otherwise, click the green add icon in the middle column to create a new job.</p>
463463
<div class="admonition hint">
464464
<p class="admonition-title">Hint</p>
@@ -471,16 +471,16 @@ <h3>How do you add bookmark items?<a class="headerlink" href="#how-do-you-add-b
471471
<div class="sd-card sd-sphinx-override sd-w-100 sd-shadow-sm docutils">
472472
<div class="sd-card-body docutils">
473473
<div class="sd-card-title sd-font-weight-bold docutils">
474-
3. Select or pick new root folders</div>
474+
2.3. Select or pick new root folders</div>
475475
<p class="sd-card-text">Select a job. If you used the default job template to create one, it comes with pre-defined root-folders (e.g. the <code class="docutils literal notranslate"><span class="pre">data/asset</span></code>, <code class="docutils literal notranslate"><span class="pre">data/shot</span></code> folders). If you used a custom template, you might need to pick a new root folder by clicking the green add icon on the right-hand side.</p>
476476
<div class="admonition hint">
477477
<p class="admonition-title">Hint</p>
478478
<p class="sd-card-text">Any folder with a <code class="docutils literal notranslate"><span class="pre">.bookmark</span></code> folder inside them will be read as a root folder. If the folder doesn’t show up, you might have to change the folder parsing depth in the preferences.</p>
479479
</div>
480+
<p class="sd-card-text">Done! Close the editor when finished.</p>
480481
</div>
481482
</div>
482483
</div>
483-
<p>Done! Close the editor when finished.</p>
484484
</div>
485485
</div>
486486
</div>
@@ -585,18 +585,18 @@ <h3>How do you add template files?<a class="headerlink" href="#how-do-you-add-te
585585
</div>
586586
<div class="section" id="how-do-you-configure-bookmark-items">
587587
<h3>How do you configure bookmark items?<a class="headerlink" href="#how-do-you-configure-bookmark-items" title="Permalink to this heading">#</a></h3>
588-
<div class="sd-card sd-sphinx-override sd-mb-3 sd-shadow-sm sd-text-center docutils">
588+
<div class="sd-card sd-sphinx-override sd-mb-3 sd-shadow-sm docutils">
589589
<div class="sd-card-body docutils">
590590
<div class="sd-card-title sd-font-weight-bold docutils">
591591
Bookmark property editor</div>
592592
<div class="figure align-default">
593-
<a class="reference internal image-reference" href="_images/bookmark_properties2.png"><img alt="_images/bookmark_properties2.png" src="_images/bookmark_properties2.png" style="width: 440px;" /></a>
593+
<a class="reference internal image-reference" href="_images/bookmark_properties2.png"><img alt="_images/bookmark_properties2.png" src="_images/bookmark_properties2.png" style="width: 480px;" /></a>
594594
</div>
595+
<p class="sd-card-text">To edit basic properties, like external URLs, frame rate, file-filter rules, width, and height attributes, select a bookmark item and click the settings icon, or hit <code class="docutils literal notranslate"><span class="pre">Ctrl+E</span></code>.</p>
596+
<p class="sd-card-text">The properties will help create footage ‘publishes’, convert image sequences, and, using the Maya plugin, set the Maya workspace and scene settings. Linking URLs and ShotGrid entities with local files can be beneficial when the project has a lot of external resources to keep track of.</p>
597+
<p class="sd-card-text">There are also filter options to associate task folders with file formats. And more!</p>
595598
</div>
596599
</div>
597-
<p>To edit basic properties, like external URLs, frame rate, file-filter rules, width, and height attributes, select a bookmark item and click the settings icon, or hit <code class="docutils literal notranslate"><span class="pre">Ctrl+E</span></code>.</p>
598-
<p>The properties will help create footage ‘publishes’, convert image sequences, and, using the Maya plugin, set the Maya workspace and scene settings. Linking URLs and ShotGrid entities with local files can be beneficial when the project has a lot of external resources to keep track of.</p>
599-
<p>There are also filter options to associate task folders with file formats. And more!</p>
600600
</div>
601601
</div>
602602
<div class="section" id="report-issues">

0 commit comments

Comments
 (0)