Skip to content

Commit

Permalink
build based on 52a6dcc
Browse files Browse the repository at this point in the history
  • Loading branch information
Documenter.jl committed Sep 23, 2024
1 parent 7d875cf commit e2a2a01
Show file tree
Hide file tree
Showing 10 changed files with 12 additions and 12 deletions.
2 changes: 1 addition & 1 deletion previews/PR159/background/history/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,4 @@
properties

# for Geometries
coordinates</code></pre><p>However, the <code>position</code> type is gone and merged with <code>PointTrait</code>.</p><section class="footnotes is-size-7"><ul><li class="footnote" id="footnote-sgillies"><a class="tag is-link" href="#citeref-sgillies">sgillies</a>https://gist.github.com/sgillies/2217756</li><li class="footnote" id="footnote-geojson"><a class="tag is-link" href="#citeref-geojson">geojson</a>https://geojson.org/</li></ul></section></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../sf/">« Simple Features</a><a class="docs-footer-nextpage" href="../../tutorials/installation/">Installation »</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.15 on <span class="colophon-date" title="Monday 23 September 2024 17:26">Monday 23 September 2024</span>. Using Julia version 1.10.5.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
coordinates</code></pre><p>However, the <code>position</code> type is gone and merged with <code>PointTrait</code>.</p><section class="footnotes is-size-7"><ul><li class="footnote" id="footnote-sgillies"><a class="tag is-link" href="#citeref-sgillies">sgillies</a>https://gist.github.com/sgillies/2217756</li><li class="footnote" id="footnote-geojson"><a class="tag is-link" href="#citeref-geojson">geojson</a>https://geojson.org/</li></ul></section></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../sf/">« Simple Features</a><a class="docs-footer-nextpage" href="../../tutorials/installation/">Installation »</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.15 on <span class="colophon-date" title="Monday 23 September 2024 17:42">Monday 23 September 2024</span>. Using Julia version 1.10.5.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
2 changes: 1 addition & 1 deletion previews/PR159/background/sf/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -10,4 +10,4 @@
spatialDimension

locateAlong
locateBetween</code></pre></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../../">« Home</a><a class="docs-footer-nextpage" href="../history/">History »</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.15 on <span class="colophon-date" title="Monday 23 September 2024 17:26">Monday 23 September 2024</span>. Using Julia version 1.10.5.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
locateBetween</code></pre></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../../">« Home</a><a class="docs-footer-nextpage" href="../history/">History »</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.15 on <span class="colophon-date" title="Monday 23 September 2024 17:42">Monday 23 September 2024</span>. Using Julia version 1.10.5.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
2 changes: 1 addition & 1 deletion previews/PR159/guides/defaults/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -14,4 +14,4 @@
GeoInterface.y(b) == 2

c = (;X=1, Y=2, Z=3)
GeoInterface.z(c) == 3</code></pre><h1 id="Wrapper-types"><a class="docs-heading-anchor" href="#Wrapper-types">Wrapper types</a><a id="Wrapper-types-1"></a><a class="docs-heading-anchor-permalink" href="#Wrapper-types" title="Permalink"></a></h1><p>It is common that a package does not implement all objects supported by GeoInterface.jl, and may lack the ability to define features. It is useful to define generic objects that can be used in testing and for scripting where geometries need to be constructed from components. Using generic wrappers means this is backend agnostic: the same code will work if geometries come from GeoJSON.jl, Shapefile.jl, LibGEOS.jl, or other packages defining GeoInterface.jl traits.</p><p>Wrapper types are provided for constructing geometries out of any lower-level components that implement GeoInterface.jl traits. These wrappers can wrap objects of the same trait (possibly to add extent data), vectors of child objects, or nested vectors of lower level children, such as points.</p><p>As an example, we can construct a polygon from any GeoInterface.jl compatible geometries that return <code>LinearRingTrait</code> from <code>GeoInterface.geomtrait</code>:</p><pre><code class="language-julia hljs">poly = Polygon([interior, hole1, hole2])</code></pre><p>See the API documentation for each wrapper for more details.</p><ul><li><a href="guides/@ref"><code>Point</code></a></li><li><a href="guides/@ref"><code>Line</code></a></li><li><a href="guides/@ref"><code>LineString</code></a></li><li><a href="guides/@ref"><code>LinearRing</code></a></li><li><a href="guides/@ref"><code>Polygon</code></a></li><li><a href="guides/@ref"><code>MultiLineString</code></a></li><li><a href="guides/@ref"><code>MultiPolygon</code></a></li><li><a href="guides/@ref"><code>MultiPoint</code></a></li><li><a href="guides/@ref"><code>PolyhedralSurface</code></a></li><li><a href="guides/@ref"><code>GeometryCollection</code></a></li></ul><p>Wrappers for Triangle, Hexagon and some other geometries are yet to be implemented. Please make a GitHub issue if you need them.</p><p>Feature and FeatureCollection wrappers are also provided, to add properties, crs and extents to any GeoInterface.jl compatible geometries.</p><ul><li><a href="guides/@ref"><code>Feature</code></a></li><li><a href="guides/@ref"><code>FeatureCollection</code></a></li></ul><p>Wrappers are not exported by default because they are very common names used by other packages. To use them directly, run <code>using GeoInterface.Wrappers</code>.</p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../developer/">« For developers</a><a class="docs-footer-nextpage" href="../../reference/api/">API »</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.15 on <span class="colophon-date" title="Monday 23 September 2024 17:26">Monday 23 September 2024</span>. Using Julia version 1.10.5.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
GeoInterface.z(c) == 3</code></pre><h1 id="Wrapper-types"><a class="docs-heading-anchor" href="#Wrapper-types">Wrapper types</a><a id="Wrapper-types-1"></a><a class="docs-heading-anchor-permalink" href="#Wrapper-types" title="Permalink"></a></h1><p>It is common that a package does not implement all objects supported by GeoInterface.jl, and may lack the ability to define features. It is useful to define generic objects that can be used in testing and for scripting where geometries need to be constructed from components. Using generic wrappers means this is backend agnostic: the same code will work if geometries come from GeoJSON.jl, Shapefile.jl, LibGEOS.jl, or other packages defining GeoInterface.jl traits.</p><p>Wrapper types are provided for constructing geometries out of any lower-level components that implement GeoInterface.jl traits. These wrappers can wrap objects of the same trait (possibly to add extent data), vectors of child objects, or nested vectors of lower level children, such as points.</p><p>As an example, we can construct a polygon from any GeoInterface.jl compatible geometries that return <code>LinearRingTrait</code> from <code>GeoInterface.geomtrait</code>:</p><pre><code class="language-julia hljs">poly = Polygon([interior, hole1, hole2])</code></pre><p>See the API documentation for each wrapper for more details.</p><ul><li><a href="guides/@ref"><code>Point</code></a></li><li><a href="guides/@ref"><code>Line</code></a></li><li><a href="guides/@ref"><code>LineString</code></a></li><li><a href="guides/@ref"><code>LinearRing</code></a></li><li><a href="guides/@ref"><code>Polygon</code></a></li><li><a href="guides/@ref"><code>MultiLineString</code></a></li><li><a href="guides/@ref"><code>MultiPolygon</code></a></li><li><a href="guides/@ref"><code>MultiPoint</code></a></li><li><a href="guides/@ref"><code>PolyhedralSurface</code></a></li><li><a href="guides/@ref"><code>GeometryCollection</code></a></li></ul><p>Wrappers for Triangle, Hexagon and some other geometries are yet to be implemented. Please make a GitHub issue if you need them.</p><p>Feature and FeatureCollection wrappers are also provided, to add properties, crs and extents to any GeoInterface.jl compatible geometries.</p><ul><li><a href="guides/@ref"><code>Feature</code></a></li><li><a href="guides/@ref"><code>FeatureCollection</code></a></li></ul><p>Wrappers are not exported by default because they are very common names used by other packages. To use them directly, run <code>using GeoInterface.Wrappers</code>.</p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../developer/">« For developers</a><a class="docs-footer-nextpage" href="../../reference/api/">API »</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.15 on <span class="colophon-date" title="Monday 23 September 2024 17:42">Monday 23 September 2024</span>. Using Julia version 1.10.5.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
2 changes: 1 addition & 1 deletion previews/PR159/guides/developer/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -77,4 +77,4 @@

# These alias for npolygon and getpolygon
GeoInterface.ngeom(::MultiPolygonTrait, geom::customgeom)::Integer
GeoInterface.getgeom(::MultiPolygonTrait, geom::customgeom, i)::&quot;PolygonTrait&quot;</code></pre></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../../tutorials/usage/">« Usage</a><a class="docs-footer-nextpage" href="../defaults/">Defaults »</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.15 on <span class="colophon-date" title="Monday 23 September 2024 17:26">Monday 23 September 2024</span>. Using Julia version 1.10.5.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
GeoInterface.getgeom(::MultiPolygonTrait, geom::customgeom, i)::&quot;PolygonTrait&quot;</code></pre></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../../tutorials/usage/">« Usage</a><a class="docs-footer-nextpage" href="../defaults/">Defaults »</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.15 on <span class="colophon-date" title="Monday 23 September 2024 17:42">Monday 23 September 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 e2a2a01

Please sign in to comment.