Skip to content

Commit

Permalink
build based on 0468142
Browse files Browse the repository at this point in the history
  • Loading branch information
Documenter.jl committed Jul 27, 2024
1 parent 1d54564 commit 890a46a
Show file tree
Hide file tree
Showing 5 changed files with 13 additions and 3 deletions.
2 changes: 1 addition & 1 deletion dev/.documenter-siteinfo.json
View file
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{"documenter":{"julia_version":"1.10.4","generation_timestamp":"2024-07-27T13:19:49","documenter_version":"1.5.0"}}
{"documenter":{"julia_version":"1.10.4","generation_timestamp":"2024-07-27T15:07:01","documenter_version":"1.5.0"}}
3 changes: 3 additions & 0 deletions dev/api_reference/index.html
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
<!DOCTYPE html>
<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>API Reference · Sentencize.jl</title><meta name="title" content="API Reference · Sentencize.jl"/><meta property="og:title" content="API Reference · Sentencize.jl"/><meta property="twitter:title" content="API Reference · Sentencize.jl"/><meta name="description" content="Documentation for Sentencize.jl."/><meta property="og:description" content="Documentation for Sentencize.jl."/><meta property="twitter:description" content="Documentation for Sentencize.jl."/><meta property="og:url" content="https://github.com/astariul/Sentencize.jl/api_reference/"/><meta property="twitter:url" content="https://github.com/astariul/Sentencize.jl/api_reference/"/><link rel="canonical" href="https://github.com/astariul/Sentencize.jl/api_reference/"/><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="../">Sentencize.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 class="is-active"><a class="tocitem" href>API Reference</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>API Reference</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>API Reference</a></li></ul></nav><div class="docs-right"><a class="docs-navbar-link" href="https://github.com/astariul/Sentencize.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/astariul/Sentencize.jl/blob/main/docs/src/api_reference.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"><ul><li><a href="#Sentencize.SUPPORTED_LANG"><code>Sentencize.SUPPORTED_LANG</code></a></li><li><a href="#Sentencize.Prefixes"><code>Sentencize.Prefixes</code></a></li><li><a href="#Sentencize.split_sentence-Tuple{AbstractString}"><code>Sentencize.split_sentence</code></a></li></ul><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="Sentencize.SUPPORTED_LANG" href="#Sentencize.SUPPORTED_LANG"><code>Sentencize.SUPPORTED_LANG</code></a> — <span class="docstring-category">Constant</span></header><section><div><pre><code class="language-julia hljs">SUPPORTED_LANG</code></pre><p>Supported languages.</p><p>Contains: </p><ul><li>&quot;ca&quot;</li><li>&quot;cs&quot;</li><li>&quot;da&quot;</li><li>&quot;de&quot;</li><li>&quot;el&quot;</li><li>&quot;en&quot;</li><li>&quot;es&quot;</li><li>&quot;fi&quot;</li><li>&quot;fr&quot;</li><li>&quot;hu&quot;</li><li>&quot;is&quot;</li><li>&quot;it&quot;</li><li>&quot;lt&quot;</li><li>&quot;lv&quot;</li><li>&quot;nl&quot;</li><li>&quot;no&quot;</li><li>&quot;pl&quot;</li><li>&quot;pt&quot;</li><li>&quot;ro&quot;</li><li>&quot;ru&quot;</li><li>&quot;sk&quot;</li><li>&quot;sl&quot;</li><li>&quot;sv&quot;</li><li>&quot;tr&quot;</li></ul></div><a class="docs-sourcelink" target="_blank" href="https://github.com/astariul/Sentencize.jl/blob/04681424ad22a9a1b1901904603f854bcd9e0fb9/src/Sentencize.jl#L8-L38">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="Sentencize.Prefixes" href="#Sentencize.Prefixes"><code>Sentencize.Prefixes</code></a> — <span class="docstring-category">Type</span></header><section><div><p>Prefixes(prefixes::Dict{T,PrefixType}=Dict{String,PrefixType}(); prefix_file::Union{String,Nothing}=nothing, lang::Union{String,Nothing}=&quot;en&quot;) where {T&lt;:AbstractString}</p><p>Constructs <code>Prefixes</code>.</p><p><strong>Arguments</strong></p><ul><li><code>prefixes::Dict{&lt;:AbstractString,PrefixType}=Dict{T,PrefixType}()</code>: Optional. A dictionary of non-breaking prefixes.</li><li><code>prefix_file::Union{String,Nothing}=nothing</code>: Optional. A path to a file containing non-breaking prefixes to add to provided <code>prefixes</code>.</li><li><code>lang::AbstractString=&quot;en&quot;</code>: Optional. The language of the non-breaking prefixes (see <code>?SUPPORTED_LANG</code> for available languages) to be added to <code>prefixes</code>.</li></ul></div><a class="docs-sourcelink" target="_blank" href="https://github.com/astariul/Sentencize.jl/blob/04681424ad22a9a1b1901904603f854bcd9e0fb9/src/Sentencize.jl#L70-L79">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="Sentencize.split_sentence-Tuple{AbstractString}" href="#Sentencize.split_sentence-Tuple{AbstractString}"><code>Sentencize.split_sentence</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">split_sentence(text::AbstractString; prefixes::Dict{&lt;:AbstractString,PrefixType}=Dict{String,PrefixType}(), prefix_file::Union{String,Nothing}=nothing, lang::Union{String,Nothing}=&quot;en&quot;)</code></pre><p>Splits a <code>text</code> into sentences.</p><p><strong>Arguments</strong></p><ul><li><code>text::AbstractString</code>: The text to split into sentences.</li><li><code>prefixes::Dict{&lt;:AbstractString,PrefixType}</code>: Optional. A dictionary of non-breaking prefixes.</li><li><code>prefix_file::Union{String,Nothing}</code>: Optional. A path to a file containing non-breaking prefixes to add to provided <code>prefixes</code>.</li><li><code>lang::Union{String,Nothing}</code>: Optional. The language of the non-breaking prefixes (see <code>?SUPPORTED_LANG</code> for available languages) to be added to <code>prefixes</code> Default is &quot;en&quot; (=English).</li></ul><p><strong>Examples</strong></p><pre><code class="language-julia hljs">split_sentence(&quot;This is a paragraph. It contains several sentences. &quot;But why,&quot; you ask?&quot;)
# Output: [&quot;This is a paragraph.&quot;, &quot;It contains several sentences.&quot;, &quot;&quot;But why,&quot; you ask?&quot;]</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/astariul/Sentencize.jl/blob/04681424ad22a9a1b1901904603f854bcd9e0fb9/src/Sentencize.jl#L158-L174">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="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.5.0 on <span class="colophon-date" title="Saturday 27 July 2024 15:07">Saturday 27 July 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 890a46a

Please sign in to comment.