build based on 6d906f5

JuliaQUBO · Dec 6, 2023 · 5992ec2 · 5992ec2
1 parent 224a7a4
commit 5992ec2
Show file tree

Hide file tree

Showing 14 changed files with 856 additions and 0 deletions.
diff --git a/previews/PR3/api/index.html b/previews/PR3/api/index.html
@@ -0,0 +1,2 @@
+<!DOCTYPE html>
+<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>API · QUBOInstances.jl</title><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.045/juliamono.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.4/css/fontawesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.4/css/solid.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.4/css/brands.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.13.24/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="../siteinfo.js"></script><script src="../../versions.js"></script><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><link href="../assets/extra_styles.css" rel="stylesheet" type="text/css"/><link href="../assets/favicon.ico" rel="icon" type="image/x-icon"/></head><body><div id="documenter"><nav class="docs-sidebar"><a class="docs-logo" href="../"><img src="../assets/logo.svg" alt="QUBOInstances.jl logo"/></a><form class="docs-search" action="../search/"><input class="docs-search-query" id="documenter-search-query" name="q" type="text" placeholder="Search docs"/></form><ul class="docs-menu"><li><a class="tocitem" href="../">Home</a></li><li class="is-active"><a class="tocitem" href>API</a><ul class="internal"><li><a class="tocitem" href="#List-items"><span>List items</span></a></li><li><a class="tocitem" href="#Load-instances"><span>Load instances</span></a></li></ul></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"><nav class="breadcrumb"><ul class="is-hidden-mobile"><li class="is-active"><a href>API</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>API</a></li></ul></nav><div class="docs-right"><a class="docs-edit-link" href="https://github.com/pedromxavier/QUBOInstances.jl/blob/main/docs/src/api.md" title="Edit on GitHub"><span class="docs-icon fab"></span><span class="docs-label is-hidden-touch">Edit on GitHub</span></a><a class="docs-settings-button fas fa-cog" id="documenter-settings-button" href="#" title="Settings"></a><a class="docs-sidebar-button fa fa-bars is-hidden-desktop" id="documenter-sidebar-button" href="#"></a></div></header><article class="content" id="documenter-page"><h1 id="API"><a class="docs-heading-anchor" href="#API">API</a><a id="API-1"></a><a class="docs-heading-anchor-permalink" href="#API" title="Permalink"></a></h1><h2 id="List-items"><a class="docs-heading-anchor" href="#List-items">List items</a><a id="List-items-1"></a><a class="docs-heading-anchor-permalink" href="#List-items" title="Permalink"></a></h2><article class="docstring"><header><a class="docstring-binding" id="QUBOInstances.list_collections" href="#QUBOInstances.list_collections"><code>QUBOInstances.list_collections</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">list_collections()</code></pre><p>List the codes of the registered collections.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/pedromxavier/QUBOInstances.jl/blob/6d906f5a78901138e6f6bf9255428b5d08c76f9c/src/public/interface.jl#L8-L12">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="QUBOInstances.list_instances" href="#QUBOInstances.list_instances"><code>QUBOInstances.list_instances</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">list_instances(collection::AbstractString)</code></pre><p>Lists the codes for all instances in a collection.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/pedromxavier/QUBOInstances.jl/blob/6d906f5a78901138e6f6bf9255428b5d08c76f9c/src/public/interface.jl#L15-L19">source</a></section></article><h2 id="Load-instances"><a class="docs-heading-anchor" href="#Load-instances">Load instances</a><a id="Load-instances-1"></a><a class="docs-heading-anchor-permalink" href="#Load-instances" title="Permalink"></a></h2><article class="docstring"><header><a class="docstring-binding" id="QUBOInstances.load_instance" href="#QUBOInstances.load_instance"><code>QUBOInstances.load_instance</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">load_instance(collection::AbstractString, instance::AbstractString)</code></pre><p>Loads a specific instance for a given collection as a QUBOTools model.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/pedromxavier/QUBOInstances.jl/blob/6d906f5a78901138e6f6bf9255428b5d08c76f9c/src/public/interface.jl#L1-L5">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../">« Home</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="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 0.27.25 on <span class="colophon-date" title="Wednesday 6 December 2023 07:11">Wednesday 6 December 2023</span>. Using Julia version 1.9.4.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
diff --git a/previews/PR3/assets/documenter.js b/previews/PR3/assets/documenter.js
diff --git a/previews/PR3/assets/extra_styles.css b/previews/PR3/assets/extra_styles.css
@@ -0,0 +1,4 @@
+.docs-sidebar .docs-logo > img {
+    max-height: 16rem !important;
+    margin: auto;
+}