Skip to content

Commit

Permalink
a little more docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@MartinuzziFrancesco
MartinuzziFrancesco committed Nov 4, 2021
1 parent ae5634f commit 5432701
Show file tree
Hide file tree
Showing 12 changed files with 20 additions and 43 deletions.
3 changes: 2 additions & 1 deletion docs/build/index.html
View file
Original file line number Diff line number Diff line change
@@ -1,2 +1,3 @@
<!DOCTYPE html>
<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>CellularAutomata.jl · CellularAutomata.jl</title><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.039/juliamono-regular.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.3/css/fontawesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.3/css/solid.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.3/css/brands.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.13.11/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="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>CellularAutomata.jl</a></span></div><form class="docs-search" action="search/"><input class="docs-search-query" id="documenter-search-query" name="q" type="text" placeholder="Search docs"/></form><ul class="docs-menu"><li class="is-active"><a class="tocitem" href>CellularAutomata.jl</a><ul class="internal"><li><a class="tocitem" href="#Contributions"><span>Contributions</span></a></li></ul></li><li><span class="tocitem">Examples</span><ul><li><a class="tocitem" href="onedim/onedimensionca/">One dimensional CA</a></li><li><a class="tocitem" href="twodim/twodimensionca/">Two dimensional CA</a></li></ul></li><li><span class="tocitem">User Guide</span><ul><li><a class="tocitem" href="user/onedimensionca/">One Dimensional CA</a></li><li><a class="tocitem" href="user/twodimensionca/">Two Dimensial CA</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"><nav class="breadcrumb"><ul class="is-hidden-mobile"><li class="is-active"><a href>CellularAutomata.jl</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>CellularAutomata.jl</a></li></ul></nav><div class="docs-right"><a class="docs-edit-link" href="https://github.com/MartinuzziFrancesco/CellularAutomata.jl/blob/master/docs/src/index.md" title="Edit on GitHub"><span class="docs-icon fab"></span><span class="docs-label is-hidden-touch">Edit on GitHub</span></a><a class="docs-settings-button fas fa-cog" id="documenter-settings-button" href="#" title="Settings"></a><a class="docs-sidebar-button fa fa-bars is-hidden-desktop" id="documenter-sidebar-button" href="#"></a></div></header><article class="content" id="documenter-page"><h1 id="CellularAutomata.jl"><a class="docs-heading-anchor" href="#CellularAutomata.jl">CellularAutomata.jl</a><a id="CellularAutomata.jl-1"></a><a class="docs-heading-anchor-permalink" href="#CellularAutomata.jl" title="Permalink"></a></h1><p>This package is meant to be a complete Open source reference for everything regarding Cellular Automata. In it you will find wayd to create one and two dimensional Cellular Automata models and functions to analyze them</p><h2 id="Contributions"><a class="docs-heading-anchor" href="#Contributions">Contributions</a><a id="Contributions-1"></a><a class="docs-heading-anchor-permalink" href="#Contributions" title="Permalink"></a></h2><p>Contributions are more than welcomed! The package is in the early days, so expet things to change a lot. For everything do contact me or open an issue about it.</p></article><nav class="docs-footer"><a class="docs-footer-nextpage" href="onedim/onedimensionca/">One dimensional CA »</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.7 on <span class="colophon-date" title="Wednesday 3 November 2021 20:59">Wednesday 3 November 2021</span>. Using Julia version 1.6.1.</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>CellularAutomata.jl · CellularAutomata.jl</title><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.039/juliamono-regular.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.3/css/fontawesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.3/css/solid.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.3/css/brands.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.13.11/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="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>CellularAutomata.jl</a></span></div><form class="docs-search" action="search/"><input class="docs-search-query" id="documenter-search-query" name="q" type="text" placeholder="Search docs"/></form><ul class="docs-menu"><li class="is-active"><a class="tocitem" href>CellularAutomata.jl</a><ul class="internal"><li><a class="tocitem" href="#General-usage"><span>General usage</span></a></li><li><a class="tocitem" href="#Contributions"><span>Contributions</span></a></li></ul></li><li><span class="tocitem">Examples</span><ul><li><a class="tocitem" href="onedim/onedimensionca/">One dimensional CA</a></li><li><a class="tocitem" href="twodim/twodimensionca/">Two dimensional CA</a></li></ul></li><li><span class="tocitem">User Guide</span><ul><li><a class="tocitem" href="user/onedimensionca/">One Dimensional CA</a></li><li><a class="tocitem" href="user/twodimensionca/">Two Dimensial CA</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"><nav class="breadcrumb"><ul class="is-hidden-mobile"><li class="is-active"><a href>CellularAutomata.jl</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>CellularAutomata.jl</a></li></ul></nav><div class="docs-right"><a class="docs-edit-link" href="https://github.com/MartinuzziFrancesco/CellularAutomata.jl/blob/master/docs/src/index.md" title="Edit on GitHub"><span class="docs-icon fab"></span><span class="docs-label is-hidden-touch">Edit on GitHub</span></a><a class="docs-settings-button fas fa-cog" id="documenter-settings-button" href="#" title="Settings"></a><a class="docs-sidebar-button fa fa-bars is-hidden-desktop" id="documenter-sidebar-button" href="#"></a></div></header><article class="content" id="documenter-page"><h1 id="CellularAutomata.jl"><a class="docs-heading-anchor" href="#CellularAutomata.jl">CellularAutomata.jl</a><a id="CellularAutomata.jl-1"></a><a class="docs-heading-anchor-permalink" href="#CellularAutomata.jl" title="Permalink"></a></h1><p>This package is meant to be a complete Open source reference for everything regarding Cellular Automata. In it you will find wayd to create one and two dimensional Cellular Automata models and functions to analyze them</p><h2 id="General-usage"><a class="docs-heading-anchor" href="#General-usage">General usage</a><a id="General-usage-1"></a><a class="docs-heading-anchor-permalink" href="#General-usage" title="Permalink"></a></h2><p>The main function is given by <code>CellularAutomaton</code></p><article class="docstring"><header><a class="docstring-binding" id="CellularAutomata.CellularAutomaton" href="#CellularAutomata.CellularAutomaton"><code>CellularAutomata.CellularAutomaton</code></a> — <span class="docstring-category">Type</span></header><section><div><pre><code class="language-julia hljs">CellularAutomaton(rule::AbstractODRule, initial_conditions, generations)
CellularAutomaton(rule::AbstractTDRule, initial_conditions, generations)</code></pre><p>Given a cellular automata rule (inluded in the library or provided by the user) returns a CellularAutomaton evolution with given initial conditions and number of generations. OD indicates one-diomensional cellular automata rules, TD indicates two-dimensiona cellular automata rules.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/MartinuzziFrancesco/CellularAutomata.jl/blob/ae5634f971e15fca70d748b2b0b694a46a216fcf/src/CellularAutomata.jl#L15-L22">source</a></section></article><p>where <code>rule</code> is a function returning the next state of the Cellular Automata. </p><h2 id="Contributions"><a class="docs-heading-anchor" href="#Contributions">Contributions</a><a id="Contributions-1"></a><a class="docs-heading-anchor-permalink" href="#Contributions" title="Permalink"></a></h2><p>Contributions are more than welcomed! The package is in the early days, so expet things to change a lot. For everything do contact me or open an issue about it.</p></article><nav class="docs-footer"><a class="docs-footer-nextpage" href="onedim/onedimensionca/">One dimensional CA »</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.7 on <span class="colophon-date" title="Thursday 4 November 2021 20:39">Thursday 4 November 2021</span>. Using Julia version 1.6.1.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
Loading

0 comments on commit 5432701

Please sign in to comment.