Skip to content

Commit

Permalink
Updated documentation.
Browse files Browse the repository at this point in the history
  • Loading branch information
@tblock79
tblock79 committed Feb 2, 2024
1 parent fb65a27 commit 4a858ca
Show file tree
Hide file tree
Showing 67 changed files with 381 additions and 4,265 deletions.
1 change: 1 addition & 0 deletions docs/_images/zulip-org-logo.svg
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion docs/_modules/bookkeeper.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
<script src="../_static/js/theme.js"></script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<a href="https://github.com/orgs/mercure-imaging/discussions" target="_none" class="chat-button">Open Chat</a>
<a href="https://mercure-imaging.zulipchat.com" target="_none" class="chat-button" title="Open mercure online community">Open Chat</a>

</head>

Expand Down
2 changes: 1 addition & 1 deletion docs/_modules/cleaner.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
<script src="../_static/js/theme.js"></script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<a href="https://github.com/orgs/mercure-imaging/discussions" target="_none" class="chat-button">Open Chat</a>
<a href="https://mercure-imaging.zulipchat.com" target="_none" class="chat-button" title="Open mercure online community">Open Chat</a>

</head>

Expand Down
2 changes: 1 addition & 1 deletion docs/_modules/common/config.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
<script src="../../_static/js/theme.js"></script>
<link rel="index" title="Index" href="../../genindex.html" />
<link rel="search" title="Search" href="../../search.html" />
<a href="https://github.com/orgs/mercure-imaging/discussions" target="_none" class="chat-button">Open Chat</a>
<a href="https://mercure-imaging.zulipchat.com" target="_none" class="chat-button" title="Open mercure online community">Open Chat</a>

</head>

Expand Down
2 changes: 1 addition & 1 deletion docs/_modules/common/constants.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
<script src="../../_static/js/theme.js"></script>
<link rel="index" title="Index" href="../../genindex.html" />
<link rel="search" title="Search" href="../../search.html" />
<a href="https://github.com/orgs/mercure-imaging/discussions" target="_none" class="chat-button">Open Chat</a>
<a href="https://mercure-imaging.zulipchat.com" target="_none" class="chat-button" title="Open mercure online community">Open Chat</a>

</head>

Expand Down
4 changes: 2 additions & 2 deletions docs/_modules/common/helper.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
<script src="../../_static/js/theme.js"></script>
<link rel="index" title="Index" href="../../genindex.html" />
<link rel="search" title="Search" href="../../search.html" />
<a href="https://github.com/orgs/mercure-imaging/discussions" target="_none" class="chat-button">Open Chat</a>
<a href="https://mercure-imaging.zulipchat.com" target="_none" class="chat-button" title="Open mercure online community">Open Chat</a>

</head>

Expand Down Expand Up @@ -246,7 +246,7 @@ <h1>Source code for common.helper</h1><div class="highlight"><pre>
<div class="viewcode-block" id="FileLock"><a class="viewcode-back" href="../../common.html#common.helper.FileLock">[docs]</a><span class="k">class</span> <span class="nc">FileLock</span><span class="p">:</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Helper class that implements a file lock. The lock file will be removed also from the destructor so that</span>
<span class="sd"> no spurious lock files remain if exceptions are raised.&quot;&quot;&quot;</span>

<span class="n">lockCreated</span> <span class="o">=</span> <span class="kc">False</span>
<span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">path_for_lockfile</span><span class="p">:</span> <span class="n">Path</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">lockfile</span> <span class="o">=</span> <span class="n">path_for_lockfile</span>
<span class="c1"># TODO: Handle case if lock file cannot be created</span>
Expand Down
2 changes: 1 addition & 1 deletion docs/_modules/common/monitor.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
<script src="../../_static/js/theme.js"></script>
<link rel="index" title="Index" href="../../genindex.html" />
<link rel="search" title="Search" href="../../search.html" />
<a href="https://github.com/orgs/mercure-imaging/discussions" target="_none" class="chat-button">Open Chat</a>
<a href="https://mercure-imaging.zulipchat.com" target="_none" class="chat-button" title="Open mercure online community">Open Chat</a>

</head>

Expand Down
Loading

0 comments on commit 4a858ca

Please sign in to comment.