Skip to content

Commit

Permalink
update core docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@kba
kba committed Oct 23, 2023
1 parent 876f188 commit dfcf8c6
Show file tree
Hide file tree
Showing 233 changed files with 27,347 additions and 17,917 deletions.
53 changes: 38 additions & 15 deletions site/core/_modules/index.html
View file
Original file line number Diff line number Diff line change
@@ -1,18 +1,16 @@

<!DOCTYPE html>

<html>
<html lang="en">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Overview: module code &#8212; ocrd 2.41.0 documentation</title>
<link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="../_static/alabaster.css" />
<script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script>
<script src="../_static/jquery.js"></script>
<script src="../_static/underscore.js"></script>
<script src="../_static/doctools.js"></script>
<script src="../_static/ocrd-custom.js"></script>
<title>Overview: module code &#8212; ocrd 2.58.1 documentation</title>
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=b76e3c8a" />
<link rel="stylesheet" type="text/css" href="../_static/alabaster.css?v=039e1c02" />
<script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js?v=c89f9379"></script>
<script src="../_static/doctools.js?v=888ff710"></script>
<script src="../_static/sphinx_highlight.js?v=4825356b"></script>
<script src="../_static/ocrd-custom.js?v=285d69d9"></script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />

Expand Down Expand Up @@ -42,7 +40,8 @@ <h1>All modules for which code is available</h1>
<ul><li><a href="ocrd/decorators/loglevel_option.html">ocrd.decorators.loglevel_option</a></li>
<li><a href="ocrd/decorators/mets_find_options.html">ocrd.decorators.mets_find_options</a></li>
<li><a href="ocrd/decorators/ocrd_cli_options.html">ocrd.decorators.ocrd_cli_options</a></li>
</ul><li><a href="ocrd/processor/base.html">ocrd.processor.base</a></li>
</ul><li><a href="ocrd/mets_server.html">ocrd.mets_server</a></li>
<li><a href="ocrd/processor/base.html">ocrd.processor.base</a></li>
<li><a href="ocrd/processor/builtin/dummy_processor.html">ocrd.processor.builtin.dummy_processor</a></li>
<li><a href="ocrd/processor/helpers.html">ocrd.processor.helpers</a></li>
<li><a href="ocrd/resolver.html">ocrd.resolver</a></li>
Expand All @@ -61,18 +60,42 @@ <h1>All modules for which code is available</h1>
<li><a href="ocrd_models/ocrd_xml_base.html">ocrd_models.ocrd_xml_base</a></li>
<li><a href="ocrd_models/report.html">ocrd_models.report</a></li>
<li><a href="ocrd_models/utils.html">ocrd_models.utils</a></li>
<li><a href="ocrd_network/client.html">ocrd_network.client</a></li>
<li><a href="ocrd_network/database.html">ocrd_network.database</a></li>
<li><a href="ocrd_network/deployer.html">ocrd_network.deployer</a></li>
<li><a href="ocrd_network/deployment_utils.html">ocrd_network.deployment_utils</a></li>
<li><a href="ocrd_network/logging.html">ocrd_network.logging</a></li>
<li><a href="ocrd_network/models/job.html">ocrd_network.models.job</a></li>
<li><a href="ocrd_network/models/messages.html">ocrd_network.models.messages</a></li>
<li><a href="ocrd_network/models/ocrd_tool.html">ocrd_network.models.ocrd_tool</a></li>
<li><a href="ocrd_network/models/workspace.html">ocrd_network.models.workspace</a></li>
<li><a href="ocrd_network/param_validators.html">ocrd_network.param_validators</a></li>
<li><a href="ocrd_network/process_helpers.html">ocrd_network.process_helpers</a></li>
<li><a href="ocrd_network/processing_server.html">ocrd_network.processing_server</a></li>
<li><a href="ocrd_network/processing_worker.html">ocrd_network.processing_worker</a></li>
<li><a href="ocrd_network/processor_server.html">ocrd_network.processor_server</a></li>
<li><a href="ocrd_network/rabbitmq_utils/connector.html">ocrd_network.rabbitmq_utils.connector</a></li>
<li><a href="ocrd_network/rabbitmq_utils/consumer.html">ocrd_network.rabbitmq_utils.consumer</a></li>
<li><a href="ocrd_network/rabbitmq_utils/ocrd_messages.html">ocrd_network.rabbitmq_utils.ocrd_messages</a></li>
<li><a href="ocrd_network/rabbitmq_utils/publisher.html">ocrd_network.rabbitmq_utils.publisher</a></li>
<li><a href="ocrd_network/runtime_data.html">ocrd_network.runtime_data</a></li>
<li><a href="ocrd_network/server_cache.html">ocrd_network.server_cache</a></li>
<li><a href="ocrd_network/server_utils.html">ocrd_network.server_utils</a></li>
<li><a href="ocrd_network/utils.html">ocrd_network.utils</a></li>
<li><a href="ocrd_utils/config.html">ocrd_utils.config</a></li>
<li><a href="ocrd_utils/deprecate.html">ocrd_utils.deprecate</a></li>
<li><a href="ocrd_utils/image.html">ocrd_utils.image</a></li>
<li><a href="ocrd_utils/introspect.html">ocrd_utils.introspect</a></li>
<li><a href="ocrd_utils/logging.html">ocrd_utils.logging</a></li>
<li><a href="ocrd_utils/os.html">ocrd_utils.os</a></li>
<li><a href="ocrd_utils/package_resources.html">ocrd_utils.package_resources</a></li>
<li><a href="ocrd_utils/str.html">ocrd_utils.str</a></li>
<li><a href="ocrd_validators/json_validator.html">ocrd_validators.json_validator</a></li>
<li><a href="ocrd_validators/ocrd_network_message_validator.html">ocrd_validators.ocrd_network_message_validator</a></li>
<li><a href="ocrd_validators/ocrd_tool_validator.html">ocrd_validators.ocrd_tool_validator</a></li>
<li><a href="ocrd_validators/ocrd_zip_validator.html">ocrd_validators.ocrd_zip_validator</a></li>
<li><a href="ocrd_validators/page_validator.html">ocrd_validators.page_validator</a></li>
<li><a href="ocrd_validators/parameter_validator.html">ocrd_validators.parameter_validator</a></li>
<li><a href="ocrd_validators/processing_server_config_validator.html">ocrd_validators.processing_server_config_validator</a></li>
<li><a href="ocrd_validators/resource_list_validator.html">ocrd_validators.resource_list_validator</a></li>
<li><a href="ocrd_validators/workspace_validator.html">ocrd_validators.workspace_validator</a></li>
<li><a href="ocrd_validators/xsd_mets_validator.html">ocrd_validators.xsd_mets_validator</a></li>
Expand Down Expand Up @@ -128,7 +151,7 @@ <h3 id="searchlabel">Quick search</h3>
</form>
</div>
</div>
<script>$('#searchbox').show(0);</script>
<script>document.getElementById('searchbox').style.display = "block"</script>



Expand All @@ -145,8 +168,8 @@ <h3 id="searchlabel">Quick search</h3>
&copy;2018-2021, OCR-D.

|
Powered by <a href="http://sphinx-doc.org/">Sphinx 4.5.0</a>
&amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>
Powered by <a href="http://sphinx-doc.org/">Sphinx 7.1.2</a>
&amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.13</a>

</div>

Expand Down
33 changes: 17 additions & 16 deletions site/core/_modules/ocrd/cli/log.html
View file
Original file line number Diff line number Diff line change
@@ -1,18 +1,16 @@

<!DOCTYPE html>

<html>
<html lang="en">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>ocrd.cli.log &#8212; ocrd 2.41.0 documentation</title>
<link rel="stylesheet" type="text/css" href="../../../_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="../../../_static/alabaster.css" />
<script data-url_root="../../../" id="documentation_options" src="../../../_static/documentation_options.js"></script>
<script src="../../../_static/jquery.js"></script>
<script src="../../../_static/underscore.js"></script>
<script src="../../../_static/doctools.js"></script>
<script src="../../../_static/ocrd-custom.js"></script>
<title>ocrd.cli.log &#8212; ocrd 2.58.1 documentation</title>
<link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=b76e3c8a" />
<link rel="stylesheet" type="text/css" href="../../../_static/alabaster.css?v=039e1c02" />
<script data-url_root="../../../" id="documentation_options" src="../../../_static/documentation_options.js?v=c89f9379"></script>
<script src="../../../_static/doctools.js?v=888ff710"></script>
<script src="../../../_static/sphinx_highlight.js?v=4825356b"></script>
<script src="../../../_static/ocrd-custom.js?v=285d69d9"></script>
<link rel="index" title="Index" href="../../../genindex.html" />
<link rel="search" title="Search" href="../../../search.html" />

Expand Down Expand Up @@ -57,14 +55,17 @@ <h1>Source code for ocrd.cli.log</h1><div class="highlight"><pre>
<span class="n">pass_log</span> <span class="o">=</span> <span class="n">click</span><span class="o">.</span><span class="n">make_pass_decorator</span><span class="p">(</span><span class="n">LogCtx</span><span class="p">)</span>

<span class="nd">@click</span><span class="o">.</span><span class="n">group</span><span class="p">(</span><span class="s2">&quot;log&quot;</span><span class="p">)</span>
<span class="nd">@click</span><span class="o">.</span><span class="n">option</span><span class="p">(</span><span class="s1">&#39;-n&#39;</span><span class="p">,</span> <span class="s1">&#39;--name&#39;</span><span class="p">,</span> <span class="n">envvar</span><span class="o">=</span><span class="s1">&#39;OCRD_TOOL_NAME&#39;</span><span class="p">,</span> <span class="n">default</span><span class="o">=</span><span class="s1">&#39;&#39;</span><span class="p">,</span> <span class="n">metavar</span><span class="o">=</span><span class="s1">&#39;LOGGER_NAME&#39;</span><span class="p">,</span> <span class="n">help</span><span class="o">=</span><span class="s1">&#39;Name of the logger&#39;</span><span class="p">,</span> <span class="n">show_default</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
<span class="nd">@click</span><span class="o">.</span><span class="n">option</span><span class="p">(</span><span class="s1">&#39;-n&#39;</span><span class="p">,</span> <span class="s1">&#39;--name&#39;</span><span class="p">,</span> <span class="n">envvar</span><span class="o">=</span><span class="s1">&#39;OCRD_TOOL_NAME&#39;</span><span class="p">,</span> <span class="n">default</span><span class="o">=</span><span class="s1">&#39;log_cli&#39;</span><span class="p">,</span> <span class="n">metavar</span><span class="o">=</span><span class="s1">&#39;LOGGER_NAME&#39;</span><span class="p">,</span> <span class="n">help</span><span class="o">=</span><span class="s1">&#39;Name of the logger&#39;</span><span class="p">,</span> <span class="n">show_default</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
<span class="nd">@click</span><span class="o">.</span><span class="n">pass_context</span>
<span class="k">def</span> <span class="nf">log_cli</span><span class="p">(</span><span class="n">ctx</span><span class="p">,</span> <span class="n">name</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>
<span class="sd">&quot;&quot;&quot;</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Logging</span>

<span class="sd"> Logger name will be ocrd.OCRD_TOOL_NAME where OCRD_TOOL_NAME is normally</span>
<span class="sd"> (when using bashlib) the name of the processor.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="n">initLogging</span><span class="p">()</span>
<span class="n">ctx</span><span class="o">.</span><span class="n">obj</span> <span class="o">=</span> <span class="n">LogCtx</span><span class="p">(</span><span class="n">name</span><span class="p">)</span>
<span class="n">ctx</span><span class="o">.</span><span class="n">obj</span> <span class="o">=</span> <span class="n">LogCtx</span><span class="p">(</span><span class="s1">&#39;ocrd.&#39;</span> <span class="o">+</span> <span class="n">name</span><span class="p">)</span>

<span class="k">def</span> <span class="nf">_bind_log_command</span><span class="p">(</span><span class="n">lvl</span><span class="p">):</span>
<span class="nd">@click</span><span class="o">.</span><span class="n">argument</span><span class="p">(</span><span class="s1">&#39;msgs&#39;</span><span class="p">,</span> <span class="n">nargs</span><span class="o">=-</span><span class="mi">1</span><span class="p">)</span>
Expand Down Expand Up @@ -134,7 +135,7 @@ <h3 id="searchlabel">Quick search</h3>
</form>
</div>
</div>
<script>$('#searchbox').show(0);</script>
<script>document.getElementById('searchbox').style.display = "block"</script>



Expand All @@ -151,8 +152,8 @@ <h3 id="searchlabel">Quick search</h3>
&copy;2018-2021, OCR-D.

|
Powered by <a href="http://sphinx-doc.org/">Sphinx 4.5.0</a>
&amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>
Powered by <a href="http://sphinx-doc.org/">Sphinx 7.1.2</a>
&amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.13</a>

</div>

Expand Down
Loading

0 comments on commit dfcf8c6

Please sign in to comment.