Skip to content

Commit

Permalink
Update docs for main
Browse files Browse the repository at this point in the history
  • Loading branch information
DocBot committed Nov 19, 2024
1 parent 2c3c456 commit 497b83b
Show file tree
Hide file tree
Showing 576 changed files with 859,201 additions and 11 deletions.
20 changes: 10 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@


* [Documentation for PR #11376](docs-pr11376/) (built from [0829207](https://github.com/cvc5/cvc5/commit/0829207) @ [PR #11376](https://github.com/cvc5/cvc5/pull/11376), Nov Tue 19, 21:55 UTC)
* [Documentation for main](docs-main/) (built from [08c0639](https://github.com/cvc5/cvc5/commit/08c0639) @ [main](https://github.com/cvc5/cvc5/tree/main), Nov Tue 19, 22:27 UTC)

***


* [Documentation for main](docs-main/) (built from [5af5df5](https://github.com/cvc5/cvc5/commit/5af5df5) @ [main](https://github.com/cvc5/cvc5/tree/main), 2 hours ago)
* [Documentation for PR #11376](docs-pr11376/) (built from [0829207](https://github.com/cvc5/cvc5/commit/0829207) @ [PR #11376](https://github.com/cvc5/cvc5/pull/11376), now)
* [Documentation for PR #11375](docs-pr11375/) (built from [716f54d](https://github.com/cvc5/cvc5/commit/716f54d) @ [PR #11375](https://github.com/cvc5/cvc5/pull/11375), 68 minutes ago)
* [Documentation for PR #11374](docs-pr11374/) (built from [3028226](https://github.com/cvc5/cvc5/commit/3028226) @ [PR #11374](https://github.com/cvc5/cvc5/pull/11374), 78 minutes ago)
* [Documentation for PR #11373](docs-pr11373/) (built from [039f5c7](https://github.com/cvc5/cvc5/commit/039f5c7) @ [PR #11373](https://github.com/cvc5/cvc5/pull/11373), 24 hours ago)
* [Documentation for main](docs-main/) (built from [08c0639](https://github.com/cvc5/cvc5/commit/08c0639) @ [main](https://github.com/cvc5/cvc5/tree/main), now)
* [Documentation for PR #11376](docs-pr11376/) (built from [0829207](https://github.com/cvc5/cvc5/commit/0829207) @ [PR #11376](https://github.com/cvc5/cvc5/pull/11376), 32 minutes ago)
* [Documentation for PR #11375](docs-pr11375/) (built from [716f54d](https://github.com/cvc5/cvc5/commit/716f54d) @ [PR #11375](https://github.com/cvc5/cvc5/pull/11375), 2 hours ago)
* [Documentation for PR #11374](docs-pr11374/) (built from [3028226](https://github.com/cvc5/cvc5/commit/3028226) @ [PR #11374](https://github.com/cvc5/cvc5/pull/11374), 2 hours ago)
* [Documentation for PR #11373](docs-pr11373/) (built from [039f5c7](https://github.com/cvc5/cvc5/commit/039f5c7) @ [PR #11373](https://github.com/cvc5/cvc5/pull/11373), 25 hours ago)
* [Documentation for PR #11372](docs-pr11372/) (built from [9eeda1f](https://github.com/cvc5/cvc5/commit/9eeda1f) @ [PR #11372](https://github.com/cvc5/cvc5/pull/11372), 3 days ago)
* [Documentation for PR #11370](docs-pr11370/) (built from [7f09c54](https://github.com/cvc5/cvc5/commit/7f09c54) @ [PR #11370](https://github.com/cvc5/cvc5/pull/11370), 5 days ago)
* [Documentation for PR #11369](docs-pr11369/) (built from [82881bd](https://github.com/cvc5/cvc5/commit/82881bd) @ [PR #11369](https://github.com/cvc5/cvc5/pull/11369), 5 days ago)
Expand All @@ -23,13 +23,13 @@
* [Documentation for PR #11359](docs-pr11359/) (built from [ba04a9f](https://github.com/cvc5/cvc5/commit/ba04a9f) @ [PR #11359](https://github.com/cvc5/cvc5/pull/11359), 7 days ago)
* [Documentation for PR #11358](docs-pr11358/) (built from [cde8a1c](https://github.com/cvc5/cvc5/commit/cde8a1c) @ [PR #11358](https://github.com/cvc5/cvc5/pull/11358), 7 days ago)
* [Documentation for PR #11355](docs-pr11355/) (built from [2b6d12f](https://github.com/cvc5/cvc5/commit/2b6d12f) @ [PR #11355](https://github.com/cvc5/cvc5/pull/11355), 8 days ago)
* [Documentation for PR #11350](docs-pr11350/) (built from [7a47c0f](https://github.com/cvc5/cvc5/commit/7a47c0f) @ [PR #11350](https://github.com/cvc5/cvc5/pull/11350), 4 hours ago)
* [Documentation for PR #11350](docs-pr11350/) (built from [7a47c0f](https://github.com/cvc5/cvc5/commit/7a47c0f) @ [PR #11350](https://github.com/cvc5/cvc5/pull/11350), 5 hours ago)
* [Documentation for PR #11346](docs-pr11346/) (built from [e0bad5e](https://github.com/cvc5/cvc5/commit/e0bad5e) @ [PR #11346](https://github.com/cvc5/cvc5/pull/11346), 4 days ago)
* [Documentation for PR #11344](docs-pr11344/) (built from [fb1d176](https://github.com/cvc5/cvc5/commit/fb1d176) @ [PR #11344](https://github.com/cvc5/cvc5/pull/11344), 60 minutes ago)
* [Documentation for PR #11344](docs-pr11344/) (built from [fb1d176](https://github.com/cvc5/cvc5/commit/fb1d176) @ [PR #11344](https://github.com/cvc5/cvc5/pull/11344), 2 hours ago)
* [Documentation for PR #11330](docs-pr11330/) (built from [83402b0](https://github.com/cvc5/cvc5/commit/83402b0) @ [PR #11330](https://github.com/cvc5/cvc5/pull/11330), 6 days ago)
* [Documentation for PR #11320](docs-pr11320/) (built from [a9556b7](https://github.com/cvc5/cvc5/commit/a9556b7) @ [PR #11320](https://github.com/cvc5/cvc5/pull/11320), 3 hours ago)
* [Documentation for PR #11320](docs-pr11320/) (built from [a9556b7](https://github.com/cvc5/cvc5/commit/a9556b7) @ [PR #11320](https://github.com/cvc5/cvc5/pull/11320), 4 hours ago)
* [Documentation for PR #11311](docs-pr11311/) (built from [5ceed4a](https://github.com/cvc5/cvc5/commit/5ceed4a) @ [PR #11311](https://github.com/cvc5/cvc5/pull/11311), 6 days ago)
* [Documentation for PR #11304](docs-pr11304/) (built from [5180b2c](https://github.com/cvc5/cvc5/commit/5180b2c) @ [PR #11304](https://github.com/cvc5/cvc5/pull/11304), 4 days ago)
* [Documentation for PR #11277](docs-pr11277/) (built from [669cc09](https://github.com/cvc5/cvc5/commit/669cc09) @ [PR #11277](https://github.com/cvc5/cvc5/pull/11277), 4 days ago)
* [Documentation for PR #9724](docs-pr9724/) (built from [1d50ae8](https://github.com/cvc5/cvc5/commit/1d50ae8) @ [PR #9724](https://github.com/cvc5/cvc5/pull/9724), 2 hours ago)
* [Documentation for PR #9503](docs-pr9503/) (built from [c4859e0](https://github.com/cvc5/cvc5/commit/c4859e0) @ [PR #9503](https://github.com/cvc5/cvc5/pull/9503), 24 hours ago)
* [Documentation for PR #9503](docs-pr9503/) (built from [c4859e0](https://github.com/cvc5/cvc5/commit/c4859e0) @ [PR #9503](https://github.com/cvc5/cvc5/pull/9503), 25 hours ago)
2 changes: 1 addition & 1 deletion docs-main
154 changes: 154 additions & 0 deletions docs-main-08c0639030e7d1de53c614e1e9b331bc0c8bf68b/api/api.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,154 @@


<!DOCTYPE html>
<html class="writer-html5" lang="en">
<head>
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />

<!-- Google tag (gtag.js) -->
<script async src="https://www.googletagmanager.com/gtag/js?id=G-ML12X2V35B"></script>
<script>
window.dataLayer = window.dataLayer || [];
function gtag(){dataLayer.push(arguments);}
gtag('js', new Date());
gtag('config', 'G-ML12X2V35B');
</script>

<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>API Documentation &mdash; cvc5 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=e59714d7" />
<link rel="stylesheet" type="text/css" href="../static/custom.css?v=b9602cbe" />


<script src="../static/jquery.js?v=5d32c60e"></script>
<script src="../static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script data-url_root="../" id="documentation_options" src="../static/documentation_options.js?v=b3ba4146"></script>
<script src="../static/doctools.js?v=888ff710"></script>
<script src="../static/sphinx_highlight.js?v=4825356b"></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="C++ API" href="cpp/cpp.html" />
<link rel="prev" title="Quickstart Guide" href="../binary/quickstart.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" class="icon icon-home">
cvc5
</a>
<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">
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../installation/installation.html">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="../binary/binary.html">Binary Documentation</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">API Documentation</a><ul>
<li class="toctree-l2"><a class="reference internal" href="cpp/cpp.html">C++ API</a></li>
<li class="toctree-l2"><a class="reference internal" href="c/c.html">C API</a></li>
<li class="toctree-l2"><a class="reference internal" href="java/java.html">Java API</a></li>
<li class="toctree-l2"><a class="reference internal" href="python/python.html">Python API</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../options.html">Options</a></li>
<li class="toctree-l1"><a class="reference internal" href="../output-tags.html">Output tags</a></li>
<li class="toctree-l1"><a class="reference internal" href="../proofs/proofs.html">Proof Production</a></li>
<li class="toctree-l1"><a class="reference internal" href="../resource-limits.html">Resource limits</a></li>
<li class="toctree-l1"><a class="reference internal" href="../skolem-ids.html">Skolem Identifiers</a></li>
<li class="toctree-l1"><a class="reference internal" href="../statistics.html">Statistics</a></li>
<li class="toctree-l1"><a class="reference internal" href="../examples/examples.html">Examples</a></li>
<li class="toctree-l1"><a class="reference internal" href="../theories/theories.html">Theory References</a></li>
<li class="toctree-l1"><a class="reference internal" href="../references.html">References</a></li>
<li class="toctree-l1"><a class="reference internal" href="../genindex.html">Index</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">cvc5</a>
</nav>

<div class="wy-nav-content">
<div class="rst-content">
<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">API Documentation</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">

<section id="api-documentation">
<h1>API Documentation<a class="headerlink" href="#api-documentation" title="Permalink to this heading"></a></h1>
<p>Alternatively to using cvc5 <a class="reference internal" href="../binary/binary.html"><span class="doc">as a binary</span></a>, cvc5 can be
integrated at the back end of other tools via one of its rich and comprehensive
APIs.</p>
<p>The primary interface of cvc5 is its <a class="reference internal" href="cpp/cpp.html"><span class="doc">C++ API</span></a>.
Its <a class="reference internal" href="c/c.html"><span class="doc">C API</span></a>, <a class="reference internal" href="java/java.html"><span class="doc">Java API</span></a> and
<a class="reference internal" href="python/base/python.html"><span class="doc">base Python API</span></a> implement a thin wrapper around
the C++ API.
In addition to the base Python API, cvc5 also provides a more <a class="reference internal" href="python/pythonic/pythonic.html"><span class="doc">pythonic
Python API</span></a> at
<a class="reference external" href="https://github.com/cvc5/cvc5_pythonic_api">https://github.com/cvc5/cvc5_pythonic_api</a>,
documented <a class="reference internal" href="python/pythonic/pythonic.html"><span class="doc">here</span></a>.</p>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="cpp/cpp.html">C++ API</a></li>
<li class="toctree-l1"><a class="reference internal" href="c/c.html">C API</a></li>
<li class="toctree-l1"><a class="reference internal" href="java/java.html">Java API</a></li>
<li class="toctree-l1"><a class="reference internal" href="python/python.html">Python API</a></li>
</ul>
</div>
</section>


</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="../binary/quickstart.html" class="btn btn-neutral float-left" title="Quickstart Guide" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="cpp/cpp.html" class="btn btn-neutral float-right" title="C++ API" 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 2024, the authors of cvc5.</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>
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>

</body>
</html>
Loading

0 comments on commit 497b83b

Please sign in to comment.