Skip to content

Commit

Permalink
build based on 0692142
Browse files Browse the repository at this point in the history
  • Loading branch information
Documenter.jl committed May 1, 2024
1 parent 2b53cae commit f9dcc5a
Show file tree
Hide file tree
Showing 5 changed files with 5 additions and 5 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.2","generation_timestamp":"2024-04-01T00:33:36","documenter_version":"1.3.0"}}
{"documenter":{"julia_version":"1.10.3","generation_timestamp":"2024-05-01T00:32:57","documenter_version":"1.4.0"}}
2 changes: 1 addition & 1 deletion dev/guide/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -45,4 +45,4 @@
Tests passed: 3
TESTING SUCCESSFUL!
julia> success
true</code></pre></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../">« Home</a><a class="docs-footer-nextpage" href="../reference/">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="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.3.0 on <span class="colophon-date" title="Monday 1 April 2024 00:33">Monday 1 April 2024</span>. Using Julia version 1.10.2.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
true</code></pre></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../">« Home</a><a class="docs-footer-nextpage" href="../reference/">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="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.0 on <span class="colophon-date" title="Wednesday 1 May 2024 00:32">Wednesday 1 May 2024</span>. Using Julia version 1.10.3.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
2 changes: 1 addition & 1 deletion dev/index.html
View file
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
<!DOCTYPE html>
<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>Home · NarrativeTest.jl</title><meta name="title" content="Home · NarrativeTest.jl"/><meta property="og:title" content="Home · NarrativeTest.jl"/><meta property="twitter:title" content="Home · NarrativeTest.jl"/><meta name="description" content="Documentation for NarrativeTest.jl."/><meta property="og:description" content="Documentation for NarrativeTest.jl."/><meta property="twitter:description" content="Documentation for NarrativeTest.jl."/><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>NarrativeTest.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 class="is-active"><a class="tocitem" href>Home</a><ul class="internal"><li><a class="tocitem" href="#Contents"><span>Contents</span></a></li><li><a class="tocitem" href="#Index"><span>Index</span></a></li></ul></li><li><a class="tocitem" href="guide/">Usage Guide</a></li><li><a class="tocitem" href="reference/">API Reference</a></li><li><a class="tocitem" href="test/">Test Suite</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>Home</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>Home</a></li></ul></nav><div class="docs-right"><a class="docs-navbar-link" href="https://github.com/MechanicalRabbit/NarrativeTest.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/MechanicalRabbit/NarrativeTest.jl/blob/master/docs/src/index.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="NarrativeTest.jl-Documentation"><a class="docs-heading-anchor" href="#NarrativeTest.jl-Documentation">NarrativeTest.jl Documentation</a><a id="NarrativeTest.jl-Documentation-1"></a><a class="docs-heading-anchor-permalink" href="#NarrativeTest.jl-Documentation" title="Permalink"></a></h1><p>NarrativeTest is a Julia library for functional testing, which lets you write the test suite in the narrative form. It permits you to describe the behavior of software components in the Markdown format, and then extract, execute, and validate any embedded test code.</p><p>NarrativeTest can be compared to the <a href="https://docs.python.org/3/library/doctest.html">Doctest</a> module (see also <a href="https://juliadocs.github.io/Documenter.jl/stable/man/doctests/">Documenter.jl</a>). It differs from Doctest in its approach to syntax: instead of presenting the test suite as a part of an interactive session, NarrativeTest uses plain code blocks with expected output in comments. It also focuses less on docstrings and documentation examples, and more on validating the ergonomics of API with &quot;literate testing&quot;.</p><h2 id="Contents"><a class="docs-heading-anchor" href="#Contents">Contents</a><a id="Contents-1"></a><a class="docs-heading-anchor-permalink" href="#Contents" title="Permalink"></a></h2><ul><li><a href="guide/#Usage-Guide">Usage Guide</a></li><li class="no-marker"><ul><li><a href="guide/#Installation">Installation</a></li><li><a href="guide/#Creating-tests">Creating tests</a></li><li><a href="guide/#Running-the-tests">Running the tests</a></li></ul></li><li><a href="reference/#API-Reference">API Reference</a></li><li><a href="test/#Test-Suite">Test Suite</a></li><li class="no-marker"><ul><li><a href="test/#Running-the-tests">Running the tests</a></li><li><a href="test/#Using-with-Test-library">Using with <code>Test</code> library</a></li><li><a href="test/#Extracting-test-cases">Extracting test cases</a></li><li><a href="test/#Running-one-test">Running one test</a></li></ul></li></ul><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="reference/#NarrativeTest.common_args"><code>NarrativeTest.common_args</code></a></li><li><a href="reference/#NarrativeTest.common_subs"><code>NarrativeTest.common_subs</code></a></li><li><a href="reference/#NarrativeTest.parsejl"><code>NarrativeTest.parsejl</code></a></li><li><a href="reference/#NarrativeTest.parsemd"><code>NarrativeTest.parsemd</code></a></li><li><a href="reference/#NarrativeTest.runtest"><code>NarrativeTest.runtest</code></a></li><li><a href="reference/#NarrativeTest.runtests"><code>NarrativeTest.runtests</code></a></li><li><a href="reference/#NarrativeTest.testset"><code>NarrativeTest.testset</code></a></li></ul></article><nav class="docs-footer"><a class="docs-footer-nextpage" href="guide/">Usage Guide »</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.3.0 on <span class="colophon-date" title="Monday 1 April 2024 00:33">Monday 1 April 2024</span>. Using Julia version 1.10.2.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>Home · NarrativeTest.jl</title><meta name="title" content="Home · NarrativeTest.jl"/><meta property="og:title" content="Home · NarrativeTest.jl"/><meta property="twitter:title" content="Home · NarrativeTest.jl"/><meta name="description" content="Documentation for NarrativeTest.jl."/><meta property="og:description" content="Documentation for NarrativeTest.jl."/><meta property="twitter:description" content="Documentation for NarrativeTest.jl."/><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>NarrativeTest.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 class="is-active"><a class="tocitem" href>Home</a><ul class="internal"><li><a class="tocitem" href="#Contents"><span>Contents</span></a></li><li><a class="tocitem" href="#Index"><span>Index</span></a></li></ul></li><li><a class="tocitem" href="guide/">Usage Guide</a></li><li><a class="tocitem" href="reference/">API Reference</a></li><li><a class="tocitem" href="test/">Test Suite</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>Home</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>Home</a></li></ul></nav><div class="docs-right"><a class="docs-navbar-link" href="https://github.com/MechanicalRabbit/NarrativeTest.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/MechanicalRabbit/NarrativeTest.jl/blob/master/docs/src/index.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="NarrativeTest.jl-Documentation"><a class="docs-heading-anchor" href="#NarrativeTest.jl-Documentation">NarrativeTest.jl Documentation</a><a id="NarrativeTest.jl-Documentation-1"></a><a class="docs-heading-anchor-permalink" href="#NarrativeTest.jl-Documentation" title="Permalink"></a></h1><p>NarrativeTest is a Julia library for functional testing, which lets you write the test suite in the narrative form. It permits you to describe the behavior of software components in the Markdown format, and then extract, execute, and validate any embedded test code.</p><p>NarrativeTest can be compared to the <a href="https://docs.python.org/3/library/doctest.html">Doctest</a> module (see also <a href="https://juliadocs.github.io/Documenter.jl/stable/man/doctests/">Documenter.jl</a>). It differs from Doctest in its approach to syntax: instead of presenting the test suite as a part of an interactive session, NarrativeTest uses plain code blocks with expected output in comments. It also focuses less on docstrings and documentation examples, and more on validating the ergonomics of API with &quot;literate testing&quot;.</p><h2 id="Contents"><a class="docs-heading-anchor" href="#Contents">Contents</a><a id="Contents-1"></a><a class="docs-heading-anchor-permalink" href="#Contents" title="Permalink"></a></h2><ul><li><a href="guide/#Usage-Guide">Usage Guide</a></li><li class="no-marker"><ul><li><a href="guide/#Installation">Installation</a></li><li><a href="guide/#Creating-tests">Creating tests</a></li><li><a href="guide/#Running-the-tests">Running the tests</a></li></ul></li><li><a href="reference/#API-Reference">API Reference</a></li><li><a href="test/#Test-Suite">Test Suite</a></li><li class="no-marker"><ul><li><a href="test/#Running-the-tests">Running the tests</a></li><li><a href="test/#Using-with-Test-library">Using with <code>Test</code> library</a></li><li><a href="test/#Extracting-test-cases">Extracting test cases</a></li><li><a href="test/#Running-one-test">Running one test</a></li></ul></li></ul><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="reference/#NarrativeTest.common_args"><code>NarrativeTest.common_args</code></a></li><li><a href="reference/#NarrativeTest.common_subs"><code>NarrativeTest.common_subs</code></a></li><li><a href="reference/#NarrativeTest.parsejl"><code>NarrativeTest.parsejl</code></a></li><li><a href="reference/#NarrativeTest.parsemd"><code>NarrativeTest.parsemd</code></a></li><li><a href="reference/#NarrativeTest.runtest"><code>NarrativeTest.runtest</code></a></li><li><a href="reference/#NarrativeTest.runtests"><code>NarrativeTest.runtests</code></a></li><li><a href="reference/#NarrativeTest.testset"><code>NarrativeTest.testset</code></a></li></ul></article><nav class="docs-footer"><a class="docs-footer-nextpage" href="guide/">Usage Guide »</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.0 on <span class="colophon-date" title="Wednesday 1 May 2024 00:32">Wednesday 1 May 2024</span>. Using Julia version 1.10.3.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
Loading

0 comments on commit f9dcc5a

Please sign in to comment.