Skip to content

Commit

Permalink
Update Documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
AtomVM Doc Bot committed Aug 15, 2024
1 parent b41d453 commit 127dfa3
Show file tree
Hide file tree
Showing 735 changed files with 127,343 additions and 0 deletions.
4 changes: 4 additions & 0 deletions doc/.buildinfo
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
config: 781e4b37e34a1e9c2a5bcec3ad4428fd
tags: 645f666f9bcd5a90fca523b33c5a78b7
Binary file added doc/.doctrees/CHANGELOG.doctree
Binary file not shown.
Binary file added doc/.doctrees/CODE_OF_CONDUCT.doctree
Binary file not shown.
Binary file added doc/.doctrees/CONTRIBUTING.doctree
Binary file not shown.
Binary file added doc/.doctrees/LICENSES/Apache-2.0.doctree
Binary file not shown.
Binary file added doc/.doctrees/SECURITY.doctree
Binary file not shown.
Binary file added doc/.doctrees/UPDATING.doctree
Binary file not shown.
Binary file added doc/.doctrees/api-reference-documentation.doctree
Binary file not shown.
Binary file added doc/.doctrees/apidocs/erlang/alisp/README.doctree
Binary file not shown.
Binary file added doc/.doctrees/apidocs/erlang/alisp/alisp.doctree
Binary file not shown.
Binary file not shown.
Binary file added doc/.doctrees/apidocs/erlang/alisp/arepl.doctree
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file added doc/.doctrees/apidocs/erlang/eavmlib/esp.doctree
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file added doc/.doctrees/apidocs/erlang/eavmlib/i2c.doctree
Binary file not shown.
Binary file not shown.
Binary file added doc/.doctrees/apidocs/erlang/eavmlib/ledc.doctree
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file added doc/.doctrees/apidocs/erlang/eavmlib/pico.doctree
Binary file not shown.
Binary file added doc/.doctrees/apidocs/erlang/eavmlib/port.doctree
Binary file not shown.
Binary file added doc/.doctrees/apidocs/erlang/eavmlib/spi.doctree
Binary file not shown.
Binary file not shown.
Binary file added doc/.doctrees/apidocs/erlang/eavmlib/uart.doctree
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file added doc/.doctrees/apidocs/erlang/estdlib/code.doctree
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file added doc/.doctrees/apidocs/erlang/estdlib/inet.doctree
Binary file not shown.
Binary file added doc/.doctrees/apidocs/erlang/estdlib/io.doctree
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file added doc/.doctrees/apidocs/erlang/estdlib/math.doctree
Binary file not shown.
Binary file added doc/.doctrees/apidocs/erlang/estdlib/net.doctree
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file added doc/.doctrees/apidocs/erlang/estdlib/sets.doctree
Binary file not shown.
Binary file not shown.
Binary file added doc/.doctrees/apidocs/erlang/estdlib/ssl.doctree
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file added doc/.doctrees/apidocs/erlang/etest/README.doctree
Binary file not shown.
Binary file added doc/.doctrees/apidocs/erlang/etest/etest.doctree
Binary file not shown.
Binary file not shown.
Binary file added doc/.doctrees/apidocs/libatomvm/functions.doctree
Binary file not shown.
Binary file added doc/.doctrees/apidocs/libatomvm/index.doctree
Binary file not shown.
Binary file added doc/.doctrees/apidocs/libatomvm/macros.doctree
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file added doc/.doctrees/apidocs/libatomvm/src/iff.c.doctree
Binary file not shown.
Binary file added doc/.doctrees/apidocs/libatomvm/src/iff.h.doctree
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file added doc/.doctrees/apidocs/libatomvm/types.doctree
Binary file not shown.
Binary file added doc/.doctrees/atomvm-internals.doctree
Binary file not shown.
Binary file added doc/.doctrees/atomvm-tooling.doctree
Binary file not shown.
Binary file added doc/.doctrees/build-instructions.doctree
Binary file not shown.
Binary file added doc/.doctrees/environment.pickle
Binary file not shown.
Binary file added doc/.doctrees/getting-started-guide.doctree
Binary file not shown.
Binary file added doc/.doctrees/index.doctree
Binary file not shown.
Binary file added doc/.doctrees/memory-management.doctree
Binary file not shown.
Binary file not shown.
Binary file added doc/.doctrees/packbeam-format.doctree
Binary file not shown.
Binary file added doc/.doctrees/programmers-guide.doctree
Binary file not shown.
Binary file added doc/.doctrees/release-notes.doctree
Binary file not shown.
Binary file added doc/.doctrees/welcome-to-atomvm.doctree
Binary file not shown.
Empty file added doc/.nojekyll
Empty file.
769 changes: 769 additions & 0 deletions doc/CHANGELOG.html

Large diffs are not rendered by default.

336 changes: 336 additions & 0 deletions doc/CODE_OF_CONDUCT.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,336 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" data-content_root="./">
<head>
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />

<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Contributor Covenant Code of Conduct &mdash; AtomVM 0.6.4+git.b284f385 documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=80d5e7a1" />
<link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=19f00094" />
<link rel="stylesheet" type="text/css" href="_static/graphviz.css?v=fd3f3429" />
<link rel="stylesheet" type="text/css" href="_static/css/custom.css?v=e925141f" />


<link rel="shortcut icon" href="_static/favicon.ico"/>
<link rel="canonical" href="https://atomvm.net/doc/CODE_OF_CONDUCT.html" />
<!--[if lt IE 9]>
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->

<script src="_static/jquery.js?v=5d32c60e"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="_static/documentation_options.js?v=c2e36ff7"></script>
<script src="_static/doctools.js?v=9a2dae69"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="Security Policy" href="SECURITY.html" />
<link rel="prev" title="Changelog" href="CHANGELOG.html" />
</head>

<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >



<a href="index.html">

<img src="_static/avm_logo_banner.png" class="logo" alt="Logo"/>
</a>
<div class="version">
branch (unreleased)
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="welcome-to-atomvm.html">Welcome to AtomVM!</a></li>
<li class="toctree-l1"><a class="reference internal" href="release-notes.html">Release Notes</a></li>
<li class="toctree-l1"><a class="reference internal" href="getting-started-guide.html">Getting Started Guide</a></li>
<li class="toctree-l1"><a class="reference internal" href="atomvm-tooling.html">AtomVM Tooling</a></li>
<li class="toctree-l1"><a class="reference internal" href="programmers-guide.html">Programmers Guide</a></li>
<li class="toctree-l1"><a class="reference internal" href="network-programming-guide.html">Network Programming Guide</a></li>
<li class="toctree-l1"><a class="reference internal" href="build-instructions.html">Build Instructions</a></li>
<li class="toctree-l1"><a class="reference internal" href="atomvm-internals.html">AtomVM Internals</a></li>
<li class="toctree-l1"><a class="reference internal" href="memory-management.html">Memory Management</a></li>
<li class="toctree-l1"><a class="reference internal" href="packbeam-format.html">Packbeam Format</a></li>
<li class="toctree-l1"><a class="reference internal" href="api-reference-documentation.html">API Reference Documentation</a></li>
<li class="toctree-l1"><a class="reference internal" href="CONTRIBUTING.html">Contributing</a></li>
<li class="toctree-l1"><a class="reference internal" href="CHANGELOG.html">Changelog</a></li>
</ul>

</div>
</div>
</nav>

<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">AtomVM</a>
</nav>

<div class="wy-nav-content">
<div class="rst-content style-external-links">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item active">Contributor Covenant Code of Conduct</li>
<li class="wy-breadcrumbs-aside">
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">

<!--
Copyright 2014 Coraline Ada Ehmke
SPDX-License-Identifier: CC-BY-4.0
-->
<section id="contributor-covenant-code-of-conduct">
<h1>Contributor Covenant Code of Conduct<a class="headerlink" href="#contributor-covenant-code-of-conduct" title="Link to this heading"></a></h1>
<section id="our-pledge">
<h2>Our Pledge<a class="headerlink" href="#our-pledge" title="Link to this heading"></a></h2>
<p>We as members, contributors, and leaders pledge to make participation in our
community a harassment-free experience for everyone, regardless of age, body
size, visible or invisible disability, ethnicity, sex characteristics, gender
identity and expression, level of experience, education, socio-economic status,
nationality, personal appearance, race, religion, or sexual identity
and orientation.</p>
<p>We pledge to act and interact in ways that contribute to an open, welcoming,
diverse, inclusive, and healthy community.</p>
</section>
<section id="our-standards">
<h2>Our Standards<a class="headerlink" href="#our-standards" title="Link to this heading"></a></h2>
<p>Examples of behavior that contributes to a positive environment for our
community include:</p>
<ul class="simple">
<li><p>Demonstrating empathy and kindness toward other people</p></li>
<li><p>Being respectful of differing opinions, viewpoints, and experiences</p></li>
<li><p>Giving and gracefully accepting constructive feedback</p></li>
<li><p>Accepting responsibility and apologizing to those affected by our mistakes,
and learning from the experience</p></li>
<li><p>Focusing on what is best not just for us as individuals, but for the
overall community</p></li>
</ul>
<p>Examples of unacceptable behavior include:</p>
<ul class="simple">
<li><p>The use of sexualized language or imagery, and sexual attention or
advances of any kind</p></li>
<li><p>Trolling, insulting or derogatory comments, and personal or political attacks</p></li>
<li><p>Public or private harassment</p></li>
<li><p>Publishing others’ private information, such as a physical or email
address, without their explicit permission</p></li>
<li><p>Other conduct which could reasonably be considered inappropriate in a
professional setting</p></li>
</ul>
</section>
<section id="enforcement-responsibilities">
<h2>Enforcement Responsibilities<a class="headerlink" href="#enforcement-responsibilities" title="Link to this heading"></a></h2>
<p>Community leaders are responsible for clarifying and enforcing our standards of
acceptable behavior and will take appropriate and fair corrective action in
response to any behavior that they deem inappropriate, threatening, offensive,
or harmful.</p>
<p>Community leaders have the right and responsibility to remove, edit, or reject
comments, commits, code, wiki edits, issues, and other contributions that are
not aligned to this Code of Conduct, and will communicate reasons for moderation
decisions when appropriate.</p>
</section>
<section id="scope">
<h2>Scope<a class="headerlink" href="#scope" title="Link to this heading"></a></h2>
<p>This Code of Conduct applies within all community spaces, and also applies when
an individual is officially representing the community in public spaces.
Examples of representing our community include using an official e-mail address,
posting via an official social media account, or acting as an appointed
representative at an online or offline event.</p>
</section>
<section id="enforcement">
<h2>Enforcement<a class="headerlink" href="#enforcement" title="Link to this heading"></a></h2>
<p>Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported to the community leaders responsible for enforcement at
davide AT uninstall.it.
All complaints will be reviewed and investigated promptly and fairly.</p>
<p>All community leaders are obligated to respect the privacy and security of the
reporter of any incident.</p>
</section>
<section id="enforcement-guidelines">
<h2>Enforcement Guidelines<a class="headerlink" href="#enforcement-guidelines" title="Link to this heading"></a></h2>
<p>Community leaders will follow these Community Impact Guidelines in determining
the consequences for any action they deem in violation of this Code of Conduct:</p>
<section id="correction">
<h3>1. Correction<a class="headerlink" href="#correction" title="Link to this heading"></a></h3>
<p><strong>Community Impact</strong>: Use of inappropriate language or other behavior deemed
unprofessional or unwelcome in the community.</p>
<p><strong>Consequence</strong>: A private, written warning from community leaders, providing
clarity around the nature of the violation and an explanation of why the
behavior was inappropriate. A public apology may be requested.</p>
</section>
<section id="warning">
<h3>2. Warning<a class="headerlink" href="#warning" title="Link to this heading"></a></h3>
<p><strong>Community Impact</strong>: A violation through a single incident or series
of actions.</p>
<p><strong>Consequence</strong>: A warning with consequences for continued behavior. No
interaction with the people involved, including unsolicited interaction with
those enforcing the Code of Conduct, for a specified period of time. This
includes avoiding interactions in community spaces as well as external channels
like social media. Violating these terms may lead to a temporary or
permanent ban.</p>
</section>
<section id="temporary-ban">
<h3>3. Temporary Ban<a class="headerlink" href="#temporary-ban" title="Link to this heading"></a></h3>
<p><strong>Community Impact</strong>: A serious violation of community standards, including
sustained inappropriate behavior.</p>
<p><strong>Consequence</strong>: A temporary ban from any sort of interaction or public
communication with the community for a specified period of time. No public or
private interaction with the people involved, including unsolicited interaction
with those enforcing the Code of Conduct, is allowed during this period.
Violating these terms may lead to a permanent ban.</p>
</section>
<section id="permanent-ban">
<h3>4. Permanent Ban<a class="headerlink" href="#permanent-ban" title="Link to this heading"></a></h3>
<p><strong>Community Impact</strong>: Demonstrating a pattern of violation of community
standards, including sustained inappropriate behavior, harassment of an
individual, or aggression toward or disparagement of classes of individuals.</p>
<p><strong>Consequence</strong>: A permanent ban from any sort of public interaction within
the community.</p>
</section>
</section>
<section id="attribution">
<h2>Attribution<a class="headerlink" href="#attribution" title="Link to this heading"></a></h2>
<p>This Code of Conduct is adapted from the <a class="reference external" href="https://www.contributor-covenant.org">Contributor Covenant</a>,
version 2.0, available at
https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.</p>
<p>Community Impact Guidelines were inspired by <a class="reference external" href="https://github.com/mozilla/diversity">Mozilla’s code of conduct
enforcement ladder</a>.</p>
<p>For answers to common questions about this code of conduct, see the FAQ at
https://www.contributor-covenant.org/faq. Translations are available at
https://www.contributor-covenant.org/translations.</p>
</section>
</section>


</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="CHANGELOG.html" class="btn btn-neutral float-left" title="Changelog" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="SECURITY.html" class="btn btn-neutral float-right" title="Security Policy" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>

<hr/>

<div role="contentinfo">
<p>&#169; Copyright 2017-2024, AtomVM.</p>
</div>

Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.


</footer>
</div>
</div>
</section>
</div>
<!--
Copyright 2023 Winford (Uncle Grumpy) <winford@object.stream>
SPDX-License-Identifier: Apache-2.0 OR LGPL-2.1-or-later
Based on the work of Michael Altfield:
https://tech.michaelaltfield.net/2020/07/18/sphinx-rtd-github-pages-1
-->



<div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="versions">
<span class="rst-current-version" data-toggle="rst-current-version">
<span class="fa fa-book">AtomVM Docs</span>
v: branch (unreleased)
<span class="fa fa-caret-down"></span>
</span>
<div class="rst-other-versions">

<dl>
<dt>Versions</dt>


<dd><a href="/doc/v0.5.0/">v0.5.0</a></dd>



<dd><a href="/doc/v0.6.0-alpha.0/">v0.6.0-alpha.0</a></dd>



<dd><a href="/doc/v0.6.0-alpha.1/">v0.6.0-alpha.1</a></dd>



<dd><a href="/doc/v0.6.0-alpha.2/">v0.6.0-alpha.2</a></dd>



<dd><a href="/doc/v0.6.0-beta.0/">v0.6.0-beta.0</a></dd>



<dd><a href="/doc/v0.6.0-beta.1/">v0.6.0-beta.1</a></dd>



<dd><a href="/doc/v0.6.0-rc.0/">v0.6.0-rc.0</a></dd>



<dd><a href="/doc/v0.6.0/">v0.6.0</a></dd>



<dd><a href="/doc/v0.6.1/">v0.6.1</a></dd>



<dd><a href="/doc/v0.6.2/">v0.6.2</a></dd>



<dd><a href="/doc/v0.6.3/">v0.6.3</a></dd>



<dd><a href="/doc/release-0.6/">release-0.6 branch (unreleased)</a></dd>


</dl>


<dl>
<dt>Downloads</dt>

<dd><a href="/doc//pdf/AtomVM-.pdf">pdf</a></dd>

<dd><a href="/doc//epub/AtomVM-.epub">epub</a></dd>

</dl>

</div>
</div>
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>

</body>
</html>
Loading

0 comments on commit 127dfa3

Please sign in to comment.