Skip to content

Commit

Permalink
build based on 4fa33a9
Browse files Browse the repository at this point in the history
  • Loading branch information
Documenter.jl committed Aug 28, 2024
1 parent 2cb5a31 commit b4068e1
Show file tree
Hide file tree
Showing 6 changed files with 10 additions and 10 deletions.
2 changes: 1 addition & 1 deletion previews/PR119/.documenter-siteinfo.json
View file
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{"documenter":{"julia_version":"1.10.5","generation_timestamp":"2024-08-28T19:52:05","documenter_version":"1.6.0"}}
{"documenter":{"julia_version":"1.10.5","generation_timestamp":"2024-08-28T20:19:28","documenter_version":"1.6.0"}}
2 changes: 1 addition & 1 deletion previews/PR119/arrow-concepts/index.html
View file
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
<!DOCTYPE html>
<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>Arrow-Related Concepts/Conventions · Legolas</title><meta name="title" content="Arrow-Related Concepts/Conventions · Legolas"/><meta property="og:title" content="Arrow-Related Concepts/Conventions · Legolas"/><meta property="twitter:title" content="Arrow-Related Concepts/Conventions · Legolas"/><meta name="description" content="Documentation for Legolas."/><meta property="og:description" content="Documentation for Legolas."/><meta property="twitter:description" content="Documentation for Legolas."/><script data-outdated-warner src="../assets/warner.js"></script><link href="https://cdnjs.cloudflare.com/ajax/libs/lato-font/3.0.0/css/lato-font.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/juliamono/0.050/juliamono.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/fontawesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/solid.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/brands.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.8/katex.min.css" rel="stylesheet" type="text/css"/><script>documenterBaseURL=".."</script><script src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.6/require.min.js" data-main="../assets/documenter.js"></script><script src="../search_index.js"></script><script src="../siteinfo.js"></script><script src="../../versions.js"></script><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/catppuccin-mocha.css" data-theme-name="catppuccin-mocha"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/catppuccin-macchiato.css" data-theme-name="catppuccin-macchiato"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/catppuccin-frappe.css" data-theme-name="catppuccin-frappe"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/catppuccin-latte.css" data-theme-name="catppuccin-latte"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/documenter-dark.css" data-theme-name="documenter-dark" data-theme-primary-dark/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/documenter-light.css" data-theme-name="documenter-light" data-theme-primary/><script src="../assets/themeswap.js"></script></head><body><div id="documenter"><nav class="docs-sidebar"><div class="docs-package-name"><span class="docs-autofit"><a href="../">Legolas</a></span></div><button class="docs-search-query input is-rounded is-small is-clickable my-2 mx-auto py-1 px-2" id="documenter-search-query">Search docs (Ctrl + /)</button><ul class="docs-menu"><li><a class="tocitem" href="../">API Documentation</a></li><li><a class="tocitem" href="../schema-concepts/">Schema-Related Concepts/Conventions</a></li><li class="is-active"><a class="tocitem" href>Arrow-Related Concepts/Conventions</a><ul class="internal"><li><a class="tocitem" href="#Supporting-Legolas-Schema-Discovery-In-Arrow-Tables"><span>Supporting Legolas Schema Discovery In Arrow Tables</span></a></li><li><a class="tocitem" href="#Arrow-File-Naming-Conventions"><span>Arrow File Naming Conventions</span></a></li></ul></li><li><a class="tocitem" href="../faq/">FAQ</a></li><li><a class="tocitem" href="../upgrade/">Upgrading from v0.4 to v0.5</a></li></ul><div class="docs-version-selector field has-addons"><div class="control"><span class="docs-label button is-static is-size-7">Version</span></div><div class="docs-selector control is-expanded"><div class="select is-fullwidth is-size-7"><select id="documenter-version-selector"></select></div></div></div></nav><div class="docs-main"><header class="docs-navbar"><a class="docs-sidebar-button docs-navbar-link fa-solid fa-bars is-hidden-desktop" id="documenter-sidebar-button" href="#"></a><nav class="breadcrumb"><ul class="is-hidden-mobile"><li class="is-active"><a href>Arrow-Related Concepts/Conventions</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>Arrow-Related Concepts/Conventions</a></li></ul></nav><div class="docs-right"><a class="docs-navbar-link" href="https://github.com/beacon-biosignals/Legolas.jl" title="View the repository on GitHub"><span class="docs-icon fa-brands"></span><span class="docs-label is-hidden-touch">GitHub</span></a><a class="docs-navbar-link" href="https://github.com/beacon-biosignals/Legolas.jl/blob/main/docs/src/arrow-concepts.md" title="Edit source on GitHub"><span class="docs-icon fa-solid"></span></a><a class="docs-settings-button docs-navbar-link fa-solid fa-gear" id="documenter-settings-button" href="#" title="Settings"></a><a class="docs-article-toggle-button fa-solid fa-chevron-up" id="documenter-article-toggle-button" href="javascript:;" title="Collapse all docstrings"></a></div></header><article class="content" id="documenter-page"><h1 id="Arrow-Related-Concepts/Conventions"><a class="docs-heading-anchor" href="#Arrow-Related-Concepts/Conventions">Arrow-Related Concepts/Conventions</a><a id="Arrow-Related-Concepts/Conventions-1"></a><a class="docs-heading-anchor-permalink" href="#Arrow-Related-Concepts/Conventions" title="Permalink"></a></h1><div class="admonition is-info"><header class="admonition-header">Note</header><div class="admonition-body"><p>If you&#39;re a newcomer to Legolas.jl, please familiarize yourself with the <a href="https://github.com/beacon-biosignals/Legolas.jl/blob/main/examples/tour.jl">tour</a> before diving into this documentation.</p></div></div><p>Legolas.jl&#39;s target (de)serialization format, <a href="https://arrow.apache.org/">Arrow</a>, already features wide cross-language adoption, enabling Legolas-serialized tables to be seamlessly read into many non-Julia environments. This documentation section contains conventions related to Legolas-serialized Arrow tables that may be observable by generic Legolas-unaware Arrow consumers.</p><h2 id="Supporting-Legolas-Schema-Discovery-In-Arrow-Tables"><a class="docs-heading-anchor" href="#Supporting-Legolas-Schema-Discovery-In-Arrow-Tables">Supporting Legolas Schema Discovery In Arrow Tables</a><a id="Supporting-Legolas-Schema-Discovery-In-Arrow-Tables-1"></a><a class="docs-heading-anchor-permalink" href="#Supporting-Legolas-Schema-Discovery-In-Arrow-Tables" title="Permalink"></a></h2><p>Legolas defines a special field <code>legolas_schema_qualified</code> that Legolas-aware Arrow writers may include in an Arrow table&#39;s table-level metadata to indicate a particular Legolas schema with which the table complies.</p><p>Arrow tables which include this field are considered to &quot;support Legolas schema discovery&quot; and are referred to as &quot;Legolas-discoverable&quot;, since Legolas consumers may employ this field to automatically match the table against available application-layer Legolas schema definitions.</p><p>If present, the <code>legolas_schema_qualified</code> field&#39;s value must be a <a href="../schema-concepts/#schema_version_identifier_specification">fully qualified schema version identifier</a>.</p><h2 id="Arrow-File-Naming-Conventions"><a class="docs-heading-anchor" href="#Arrow-File-Naming-Conventions">Arrow File Naming Conventions</a><a id="Arrow-File-Naming-Conventions-1"></a><a class="docs-heading-anchor-permalink" href="#Arrow-File-Naming-Conventions" title="Permalink"></a></h2><p>When writing a Legolas-discoverable Arrow table to a file, prefer using the file extension <code>*.&lt;schema name&gt;.arrow</code>. For example, if the file&#39;s table&#39;s full Legolas schema version identifier is <code>baz.supercar@1&gt;bar.automobile@1</code>, use the file extension <code>*.baz.supercar.arrow</code>.</p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../schema-concepts/">« Schema-Related Concepts/Conventions</a><a class="docs-footer-nextpage" href="../faq/">FAQ »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.6.0 on <span class="colophon-date" title="Wednesday 28 August 2024 19:52">Wednesday 28 August 2024</span>. Using Julia version 1.10.5.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>Arrow-Related Concepts/Conventions · Legolas</title><meta name="title" content="Arrow-Related Concepts/Conventions · Legolas"/><meta property="og:title" content="Arrow-Related Concepts/Conventions · Legolas"/><meta property="twitter:title" content="Arrow-Related Concepts/Conventions · Legolas"/><meta name="description" content="Documentation for Legolas."/><meta property="og:description" content="Documentation for Legolas."/><meta property="twitter:description" content="Documentation for Legolas."/><script data-outdated-warner src="../assets/warner.js"></script><link href="https://cdnjs.cloudflare.com/ajax/libs/lato-font/3.0.0/css/lato-font.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/juliamono/0.050/juliamono.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/fontawesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/solid.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/brands.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.8/katex.min.css" rel="stylesheet" type="text/css"/><script>documenterBaseURL=".."</script><script src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.6/require.min.js" data-main="../assets/documenter.js"></script><script src="../search_index.js"></script><script src="../siteinfo.js"></script><script src="../../versions.js"></script><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/catppuccin-mocha.css" data-theme-name="catppuccin-mocha"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/catppuccin-macchiato.css" data-theme-name="catppuccin-macchiato"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/catppuccin-frappe.css" data-theme-name="catppuccin-frappe"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/catppuccin-latte.css" data-theme-name="catppuccin-latte"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/documenter-dark.css" data-theme-name="documenter-dark" data-theme-primary-dark/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/documenter-light.css" data-theme-name="documenter-light" data-theme-primary/><script src="../assets/themeswap.js"></script></head><body><div id="documenter"><nav class="docs-sidebar"><div class="docs-package-name"><span class="docs-autofit"><a href="../">Legolas</a></span></div><button class="docs-search-query input is-rounded is-small is-clickable my-2 mx-auto py-1 px-2" id="documenter-search-query">Search docs (Ctrl + /)</button><ul class="docs-menu"><li><a class="tocitem" href="../">API Documentation</a></li><li><a class="tocitem" href="../schema-concepts/">Schema-Related Concepts/Conventions</a></li><li class="is-active"><a class="tocitem" href>Arrow-Related Concepts/Conventions</a><ul class="internal"><li><a class="tocitem" href="#Supporting-Legolas-Schema-Discovery-In-Arrow-Tables"><span>Supporting Legolas Schema Discovery In Arrow Tables</span></a></li><li><a class="tocitem" href="#Arrow-File-Naming-Conventions"><span>Arrow File Naming Conventions</span></a></li></ul></li><li><a class="tocitem" href="../faq/">FAQ</a></li><li><a class="tocitem" href="../upgrade/">Upgrading from v0.4 to v0.5</a></li></ul><div class="docs-version-selector field has-addons"><div class="control"><span class="docs-label button is-static is-size-7">Version</span></div><div class="docs-selector control is-expanded"><div class="select is-fullwidth is-size-7"><select id="documenter-version-selector"></select></div></div></div></nav><div class="docs-main"><header class="docs-navbar"><a class="docs-sidebar-button docs-navbar-link fa-solid fa-bars is-hidden-desktop" id="documenter-sidebar-button" href="#"></a><nav class="breadcrumb"><ul class="is-hidden-mobile"><li class="is-active"><a href>Arrow-Related Concepts/Conventions</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>Arrow-Related Concepts/Conventions</a></li></ul></nav><div class="docs-right"><a class="docs-navbar-link" href="https://github.com/beacon-biosignals/Legolas.jl" title="View the repository on GitHub"><span class="docs-icon fa-brands"></span><span class="docs-label is-hidden-touch">GitHub</span></a><a class="docs-navbar-link" href="https://github.com/beacon-biosignals/Legolas.jl/blob/main/docs/src/arrow-concepts.md" title="Edit source on GitHub"><span class="docs-icon fa-solid"></span></a><a class="docs-settings-button docs-navbar-link fa-solid fa-gear" id="documenter-settings-button" href="#" title="Settings"></a><a class="docs-article-toggle-button fa-solid fa-chevron-up" id="documenter-article-toggle-button" href="javascript:;" title="Collapse all docstrings"></a></div></header><article class="content" id="documenter-page"><h1 id="Arrow-Related-Concepts/Conventions"><a class="docs-heading-anchor" href="#Arrow-Related-Concepts/Conventions">Arrow-Related Concepts/Conventions</a><a id="Arrow-Related-Concepts/Conventions-1"></a><a class="docs-heading-anchor-permalink" href="#Arrow-Related-Concepts/Conventions" title="Permalink"></a></h1><div class="admonition is-info"><header class="admonition-header">Note</header><div class="admonition-body"><p>If you&#39;re a newcomer to Legolas.jl, please familiarize yourself with the <a href="https://github.com/beacon-biosignals/Legolas.jl/blob/main/examples/tour.jl">tour</a> before diving into this documentation.</p></div></div><p>Legolas.jl&#39;s target (de)serialization format, <a href="https://arrow.apache.org/">Arrow</a>, already features wide cross-language adoption, enabling Legolas-serialized tables to be seamlessly read into many non-Julia environments. This documentation section contains conventions related to Legolas-serialized Arrow tables that may be observable by generic Legolas-unaware Arrow consumers.</p><h2 id="Supporting-Legolas-Schema-Discovery-In-Arrow-Tables"><a class="docs-heading-anchor" href="#Supporting-Legolas-Schema-Discovery-In-Arrow-Tables">Supporting Legolas Schema Discovery In Arrow Tables</a><a id="Supporting-Legolas-Schema-Discovery-In-Arrow-Tables-1"></a><a class="docs-heading-anchor-permalink" href="#Supporting-Legolas-Schema-Discovery-In-Arrow-Tables" title="Permalink"></a></h2><p>Legolas defines a special field <code>legolas_schema_qualified</code> that Legolas-aware Arrow writers may include in an Arrow table&#39;s table-level metadata to indicate a particular Legolas schema with which the table complies.</p><p>Arrow tables which include this field are considered to &quot;support Legolas schema discovery&quot; and are referred to as &quot;Legolas-discoverable&quot;, since Legolas consumers may employ this field to automatically match the table against available application-layer Legolas schema definitions.</p><p>If present, the <code>legolas_schema_qualified</code> field&#39;s value must be a <a href="../schema-concepts/#schema_version_identifier_specification">fully qualified schema version identifier</a>.</p><h2 id="Arrow-File-Naming-Conventions"><a class="docs-heading-anchor" href="#Arrow-File-Naming-Conventions">Arrow File Naming Conventions</a><a id="Arrow-File-Naming-Conventions-1"></a><a class="docs-heading-anchor-permalink" href="#Arrow-File-Naming-Conventions" title="Permalink"></a></h2><p>When writing a Legolas-discoverable Arrow table to a file, prefer using the file extension <code>*.&lt;schema name&gt;.arrow</code>. For example, if the file&#39;s table&#39;s full Legolas schema version identifier is <code>baz.supercar@1&gt;bar.automobile@1</code>, use the file extension <code>*.baz.supercar.arrow</code>.</p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../schema-concepts/">« Schema-Related Concepts/Conventions</a><a class="docs-footer-nextpage" href="../faq/">FAQ »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.6.0 on <span class="colophon-date" title="Wednesday 28 August 2024 20:19">Wednesday 28 August 2024</span>. Using Julia version 1.10.5.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
Loading

0 comments on commit b4068e1

Please sign in to comment.