Skip to content

Commit

Permalink
build based on a44b6db
Browse files Browse the repository at this point in the history
  • Loading branch information
Documenter.jl committed Jun 17, 2024
1 parent f2c8c4e commit 7f1bc83
Show file tree
Hide file tree
Showing 17 changed files with 1,236 additions and 0 deletions.
1 change: 1 addition & 0 deletions dev/.documenter-siteinfo.json
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{"documenter":{"julia_version":"1.10.4","generation_timestamp":"2024-06-17T14:16:11","documenter_version":"1.4.1"}}
18 changes: 18 additions & 0 deletions dev/api/index.html
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
<!DOCTYPE html>
<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>API · QGIS</title><meta name="title" content="API · QGIS"/><meta property="og:title" content="API · QGIS"/><meta property="twitter:title" content="API · QGIS"/><meta name="description" content="Documentation for QGIS."/><meta property="og:description" content="Documentation for QGIS."/><meta property="twitter:description" content="Documentation for QGIS."/><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/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="https://rsms.me/inter/inter.css" rel="stylesheet" type="text/css"/></head><body><div id="documenter"><nav class="docs-sidebar"><div class="docs-package-name"><span class="docs-autofit"><a href="../">QGIS</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="../">QGIS.jl</a></li><li><a class="tocitem" href="../tutorial/">Tutorial</a></li><li class="is-active"><a class="tocitem" href>API</a><ul class="internal"><li><a class="tocitem" href="#Table-of-Contents"><span>Table of Contents</span></a></li><li><a class="tocitem" href="#Docstrings"><span>Docstrings</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"><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>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-navbar-link" href="https://github.com/JuliaComputing/QGIS.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/JuliaComputing/QGIS.jl/blob/main/docs/src/api.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="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="Table-of-Contents"><a class="docs-heading-anchor" href="#Table-of-Contents">Table of Contents</a><a id="Table-of-Contents-1"></a><a class="docs-heading-anchor-permalink" href="#Table-of-Contents" title="Permalink"></a></h2><ul><li><a href="#QGIS.df"><code>QGIS.df</code></a></li><li><a href="#QGIS.Algorithm"><code>QGIS.Algorithm</code></a></li><li><a href="#QGIS.help-Tuple{AbstractString}"><code>QGIS.help</code></a></li><li><a href="#QGIS.metadata-Tuple{Any}"><code>QGIS.metadata</code></a></li></ul><h2 id="Docstrings"><a class="docs-heading-anchor" href="#Docstrings">Docstrings</a><a id="Docstrings-1"></a><a class="docs-heading-anchor-permalink" href="#Docstrings" title="Permalink"></a></h2><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="QGIS.df" href="#QGIS.df"><code>QGIS.df</code></a> — <span class="docstring-category">Constant</span></header><section><div><pre><code class="language-julia hljs">QGIS.df</code></pre><p>A <code>DataFrame</code> containing the metadata for all available QGIS algorithms.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaComputing/QGIS.jl/blob/a44b6db0f3a90f2c6a7c0595c458d988d9b84240/src/QGIS.jl#L12-L16">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="QGIS.Algorithm" href="#QGIS.Algorithm"><code>QGIS.Algorithm</code></a> — <span class="docstring-category">Type</span></header><section><div><pre><code class="language-julia hljs">QGIS.Algorithm(name)</code></pre><p>Object representing a QGIS algorithm. The struct contains the help, metadata, and default parameters for the algorithm. Algorithms are callable and expect a <code>String</code> input (filename) and optional <code>String</code> output (filename).</p><p><strong>Example</strong></p><pre><code class="nohighlight hljs">using QGIS, GeoJSON, Plots, GeoInterfaceRecipes

buffer = QGIS.Algorithm(&quot;native:buffer&quot;, DISTANCE=0.1)

input = joinpath(dirname(pathof(QGIS)), &quot;..&quot;, &quot;test&quot;, &quot;nc.geojson&quot;)

nc = GeoJSON.read(input)

output = buffer(input)

nc_buffered = GeoJSON.read(output)

plot(
plot(nc.geometry),
plot(nc_buffered.geometry),
layout = (2, 1)
)</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaComputing/QGIS.jl/blob/a44b6db0f3a90f2c6a7c0595c458d988d9b84240/src/QGIS.jl#L96-L122">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="QGIS.help-Tuple{AbstractString}" href="#QGIS.help-Tuple{AbstractString}"><code>QGIS.help</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">help(alg)</code></pre><p>Return the help (in JSON format) for the associated algorithm.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaComputing/QGIS.jl/blob/a44b6db0f3a90f2c6a7c0595c458d988d9b84240/src/QGIS.jl#L60-L64">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="QGIS.metadata-Tuple{Any}" href="#QGIS.metadata-Tuple{Any}"><code>QGIS.metadata</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">metadata(alg)</code></pre><p>Return the associated metadata for a given algorithm. Returns the associated <code>DataFrameRow</code> from <code>QGIS.df</code>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaComputing/QGIS.jl/blob/a44b6db0f3a90f2c6a7c0595c458d988d9b84240/src/QGIS.jl#L70-L74">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../tutorial/">« Tutorial</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></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.4.1 on <span class="colophon-date" title="Monday 17 June 2024 14:16">Monday 17 June 2024</span>. Using Julia version 1.10.4.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
Loading

0 comments on commit 7f1bc83

Please sign in to comment.