Skip to content

Commit

Permalink
build based on ab0f050
Browse files Browse the repository at this point in the history
  • Loading branch information
Documenter.jl committed Oct 15, 2023
1 parent 69cdcdf commit 9c51860
Show file tree
Hide file tree
Showing 8 changed files with 30 additions and 16 deletions.
2 changes: 1 addition & 1 deletion previews/PR27/.documenter-siteinfo.json
View file
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{"documenter":{"julia_version":"1.9.3","generation_timestamp":"2023-10-14T22:19:34","documenter_version":"1.1.1"}}
{"documenter":{"julia_version":"1.9.3","generation_timestamp":"2023-10-15T10:25:16","documenter_version":"1.1.1"}}
4 changes: 2 additions & 2 deletions previews/PR27/advanced/index.html
View file

Large diffs are not rendered by default.

12 changes: 6 additions & 6 deletions previews/PR27/api/index.html
View file

Large diffs are not rendered by default.

12 changes: 12 additions & 0 deletions previews/PR27/baseinterfaces.jl
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# BaseInterfaces reference

## Docstrings

```@autodocs
Modules = [BaseInterfaces]
```

## Index

```@index
```
2 changes: 2 additions & 0 deletions previews/PR27/baseinterfaces/index.html
View file
Original file line number Diff line number Diff line change
@@ -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>BaseInterfaces.jl reference · Interfaces.jl</title><meta name="title" content="BaseInterfaces.jl reference · Interfaces.jl"/><meta property="og:title" content="BaseInterfaces.jl reference · Interfaces.jl"/><meta property="twitter:title" content="BaseInterfaces.jl reference · Interfaces.jl"/><meta name="description" content="Documentation for Interfaces.jl."/><meta property="og:description" content="Documentation for Interfaces.jl."/><meta property="twitter:description" content="Documentation for Interfaces.jl."/><meta property="og:url" content="https://rafaqz.github.io/Interfaces.jl/baseinterfaces/"/><meta property="twitter:url" content="https://rafaqz.github.io/Interfaces.jl/baseinterfaces/"/><link rel="canonical" href="https://rafaqz.github.io/Interfaces.jl/baseinterfaces/"/><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></head><body><div id="documenter"><nav class="docs-sidebar"><div class="docs-package-name"><span class="docs-autofit"><a href="../">Interfaces.jl</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="../">Home</a></li><li><span class="tocitem">Examples</span><ul><li><a class="tocitem" href="../basic/">Basic</a></li><li><a class="tocitem" href="../advanced/">Advanced</a></li></ul></li><li><a class="tocitem" href="../api/">API reference</a></li><li class="is-active"><a class="tocitem" href>BaseInterfaces.jl reference</a><ul class="internal"><li><a class="tocitem" href="#Docstrings"><span>Docstrings</span></a></li><li><a class="tocitem" href="#Index"><span>Index</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>BaseInterfaces.jl reference</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>BaseInterfaces.jl reference</a></li></ul></nav><div class="docs-right"><a class="docs-navbar-link" href="https://github.com/rafaqz/Interfaces.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/rafaqz/Interfaces.jl/blob/main/docs/src/baseinterfaces.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="BaseInterfaces-reference"><a class="docs-heading-anchor" href="#BaseInterfaces-reference">BaseInterfaces reference</a><a id="BaseInterfaces-reference-1"></a><a class="docs-heading-anchor-permalink" href="#BaseInterfaces-reference" title="Permalink"></a></h1><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="BaseInterfaces.ArrayInterface" href="#BaseInterfaces.ArrayInterface"><code>BaseInterfaces.ArrayInterface</code></a> — <span class="docstring-category">Type</span></header><section><div><pre><code class="language-julia hljs"> ArrayInterface</code></pre><p>An Interfaces.jl <code>Interface</code> with mandatory components <code>(:type, :eltype, :ndims, :size, :getindex, :indexstyle)</code> and optional components <code>(:setindex!, :similar_type, :similar_eltype, :similar_size)</code>.</p><p>Base Julia AbstractArray interface</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/rafaqz/Interfaces.jl/blob/ab0f05034f56d662910f1cb85d0120b6b804c9f7/src/interface.jl#L70-L76">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="BaseInterfaces.DictInterface" href="#BaseInterfaces.DictInterface"><code>BaseInterfaces.DictInterface</code></a> — <span class="docstring-category">Type</span></header><section><div><pre><code class="language-julia hljs"> DictInterface</code></pre><p>An Interfaces.jl <code>Interface</code> with mandatory components <code>(:type, :iterate, :eltype, :getindex)</code> and optional components <code>(:setindex,)</code>.</p><p><code>AbstractDict</code> interface requires Arguments, with <code>d = the_dict</code> mandatory, and when <code>setindex</code> is needed, <code>k = any_valid_key_not_in_d, v = any_valid_val</code></p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/rafaqz/Interfaces.jl/blob/ab0f05034f56d662910f1cb85d0120b6b804c9f7/src/interface.jl#L70-L76">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="BaseInterfaces.IterationInterface" href="#BaseInterfaces.IterationInterface"><code>BaseInterfaces.IterationInterface</code></a> — <span class="docstring-category">Type</span></header><section><div><pre><code class="language-julia hljs"> IterationInterface</code></pre><p>An Interfaces.jl <code>Interface</code> with mandatory components <code>(:iterate, :size, :eltype)</code> and optional components <code>(:reverse, :indexing)</code>.</p><p>An interface for Base Julia iteration</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/rafaqz/Interfaces.jl/blob/ab0f05034f56d662910f1cb85d0120b6b804c9f7/src/interface.jl#L70-L76">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="BaseInterfaces.SetInterface" href="#BaseInterfaces.SetInterface"><code>BaseInterfaces.SetInterface</code></a> — <span class="docstring-category">Type</span></header><section><div><pre><code class="language-julia hljs"> SetInterface</code></pre><p>An Interfaces.jl <code>Interface</code> with mandatory components <code>(:type, :eltype, :length, :iteration, :in)</code> and optional components <code>(:copy, :empty, :emptymutable, :hasfastin, :setdiff, :intersect, :union, :empty!, :delete!, :push!, :copymutable, :sizehint)</code>.</p><p>The <code>AbstractSet</code> interface</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/rafaqz/Interfaces.jl/blob/ab0f05034f56d662910f1cb85d0120b6b804c9f7/src/interface.jl#L70-L76">source</a></section></article><h2 id="Index"><a class="docs-heading-anchor" href="#Index">Index</a><a id="Index-1"></a><a class="docs-heading-anchor-permalink" href="#Index" title="Permalink"></a></h2><ul><li><a href="../api/#Interfaces.Interfaces"><code>Interfaces.Interfaces</code></a></li><li><a href="#BaseInterfaces.ArrayInterface"><code>BaseInterfaces.ArrayInterface</code></a></li><li><a href="#BaseInterfaces.DictInterface"><code>BaseInterfaces.DictInterface</code></a></li><li><a href="#BaseInterfaces.IterationInterface"><code>BaseInterfaces.IterationInterface</code></a></li><li><a href="#BaseInterfaces.SetInterface"><code>BaseInterfaces.SetInterface</code></a></li><li><a href="../api/#Interfaces.Arguments"><code>Interfaces.Arguments</code></a></li><li><a href="../api/#Interfaces.Interface"><code>Interfaces.Interface</code></a></li><li><a href="../api/#Interfaces.components"><code>Interfaces.components</code></a></li><li><a href="../api/#Interfaces.description"><code>Interfaces.description</code></a></li><li><a href="../api/#Interfaces.implemented_trait-Union{Tuple{T}, Tuple{Type{T}, Any}} where T&lt;:Interfaces.Interface"><code>Interfaces.implemented_trait</code></a></li><li><a href="../api/#Interfaces.implements"><code>Interfaces.implements</code></a></li><li><a href="../api/#Interfaces.optional_keys"><code>Interfaces.optional_keys</code></a></li><li><a href="../api/#Interfaces.test-Union{Tuple{Keys}, Tuple{Type{&lt;:Interfaces.Interface{Keys}}, Type, Any}} where Keys"><code>Interfaces.test</code></a></li><li><a href="../api/#Interfaces.@implements-Tuple{Any, Any}"><code>Interfaces.@implements</code></a></li><li><a href="../api/#Interfaces.@interface-Tuple{Symbol, Any, Any}"><code>Interfaces.@interface</code></a></li></ul></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../api/">« API reference</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><option value="auto">Automatic (OS)</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.1.1 on <span class="colophon-date" title="Sunday 15 October 2023 10:25">Sunday 15 October 2023</span>. Using Julia version 1.9.3.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
Loading

0 comments on commit 9c51860

Please sign in to comment.