Skip to content

Commit

Permalink
Update docs for pr11578
Browse files Browse the repository at this point in the history
  • Loading branch information
DocBot committed Jan 30, 2025
1 parent 2fca7fe commit 7300538
Show file tree
Hide file tree
Showing 576 changed files with 874,892 additions and 7 deletions.
15 changes: 8 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,15 @@


* [Documentation for PR #11576](docs-pr11576/) (built from [6705814](https://github.com/cvc5/cvc5/commit/6705814) @ [PR #11576](https://github.com/cvc5/cvc5/pull/11576), Jan Thu 30, 15:54 UTC)
* [Documentation for PR #11578](docs-pr11578/) (built from [91f225a](https://github.com/cvc5/cvc5/commit/91f225a) @ [PR #11578](https://github.com/cvc5/cvc5/pull/11578), Jan Thu 30, 19:58 UTC)

***


* [Documentation for cvc5-1.2.1](docs-cvc5-1.2.1/) (built from [dc565d9](https://github.com/cvc5/cvc5/commit/dc565d9) @ [cvc5-1.2.1](https://github.com/cvc5/cvc5/tree/cvc5-1.2.1), 3 days ago)
* [Documentation for main](docs-main/) (built from [27e184d](https://github.com/cvc5/cvc5/commit/27e184d) @ [main](https://github.com/cvc5/cvc5/tree/main), 2 days ago)
* [Documentation for PR #11576](docs-pr11576/) (built from [6705814](https://github.com/cvc5/cvc5/commit/6705814) @ [PR #11576](https://github.com/cvc5/cvc5/pull/11576), now)
* [Documentation for PR #11575](docs-pr11575/) (built from [2d92657](https://github.com/cvc5/cvc5/commit/2d92657) @ [PR #11575](https://github.com/cvc5/cvc5/pull/11575), 3 hours ago)
* [Documentation for PR #11578](docs-pr11578/) (built from [91f225a](https://github.com/cvc5/cvc5/commit/91f225a) @ [PR #11578](https://github.com/cvc5/cvc5/pull/11578), now)
* [Documentation for PR #11576](docs-pr11576/) (built from [6705814](https://github.com/cvc5/cvc5/commit/6705814) @ [PR #11576](https://github.com/cvc5/cvc5/pull/11576), 4 hours ago)
* [Documentation for PR #11575](docs-pr11575/) (built from [2d92657](https://github.com/cvc5/cvc5/commit/2d92657) @ [PR #11575](https://github.com/cvc5/cvc5/pull/11575), 7 hours ago)
* [Documentation for PR #11574](docs-pr11574/) (built from [b7ab1be](https://github.com/cvc5/cvc5/commit/b7ab1be) @ [PR #11574](https://github.com/cvc5/cvc5/pull/11574), 2 days ago)
* [Documentation for PR #11573](docs-pr11573/) (built from [365bdae](https://github.com/cvc5/cvc5/commit/365bdae) @ [PR #11573](https://github.com/cvc5/cvc5/pull/11573), 2 days ago)
* [Documentation for PR #11572](docs-pr11572/) (built from [88daef0](https://github.com/cvc5/cvc5/commit/88daef0) @ [PR #11572](https://github.com/cvc5/cvc5/pull/11572), 2 days ago)
Expand All @@ -32,11 +33,11 @@
* [Documentation for PR #11553](docs-pr11553/) (built from [48c68ac](https://github.com/cvc5/cvc5/commit/48c68ac) @ [PR #11553](https://github.com/cvc5/cvc5/pull/11553), 8 days ago)
* [Documentation for PR #11531](docs-pr11531/) (built from [0d11145](https://github.com/cvc5/cvc5/commit/0d11145) @ [PR #11531](https://github.com/cvc5/cvc5/pull/11531), 8 days ago)
* [Documentation for PR #11523](docs-pr11523/) (built from [2f533f6](https://github.com/cvc5/cvc5/commit/2f533f6) @ [PR #11523](https://github.com/cvc5/cvc5/pull/11523), 8 days ago)
* [Documentation for PR #11519](docs-pr11519/) (built from [2458f66](https://github.com/cvc5/cvc5/commit/2458f66) @ [PR #11519](https://github.com/cvc5/cvc5/pull/11519), 14 hours ago)
* [Documentation for PR #11519](docs-pr11519/) (built from [2458f66](https://github.com/cvc5/cvc5/commit/2458f66) @ [PR #11519](https://github.com/cvc5/cvc5/pull/11519), 18 hours ago)
* [Documentation for PR #11514](docs-pr11514/) (built from [a24809f](https://github.com/cvc5/cvc5/commit/a24809f) @ [PR #11514](https://github.com/cvc5/cvc5/pull/11514), 7 days ago)
* [Documentation for PR #11511](docs-pr11511/) (built from [fbd17bf](https://github.com/cvc5/cvc5/commit/fbd17bf) @ [PR #11511](https://github.com/cvc5/cvc5/pull/11511), 17 hours ago)
* [Documentation for PR #11511](docs-pr11511/) (built from [fbd17bf](https://github.com/cvc5/cvc5/commit/fbd17bf) @ [PR #11511](https://github.com/cvc5/cvc5/pull/11511), 22 hours ago)
* [Documentation for PR #11507](docs-pr11507/) (built from [bf13c9a](https://github.com/cvc5/cvc5/commit/bf13c9a) @ [PR #11507](https://github.com/cvc5/cvc5/pull/11507), 8 days ago)
* [Documentation for PR #11497](docs-pr11497/) (built from [3a933ad](https://github.com/cvc5/cvc5/commit/3a933ad) @ [PR #11497](https://github.com/cvc5/cvc5/pull/11497), 6 days ago)
* [Documentation for PR #11494](docs-pr11494/) (built from [97b9cee](https://github.com/cvc5/cvc5/commit/97b9cee) @ [PR #11494](https://github.com/cvc5/cvc5/pull/11494), 17 hours ago)
* [Documentation for PR #11447](docs-pr11447/) (built from [59b7f74](https://github.com/cvc5/cvc5/commit/59b7f74) @ [PR #11447](https://github.com/cvc5/cvc5/pull/11447), 17 hours ago)
* [Documentation for PR #11494](docs-pr11494/) (built from [97b9cee](https://github.com/cvc5/cvc5/commit/97b9cee) @ [PR #11494](https://github.com/cvc5/cvc5/pull/11494), 21 hours ago)
* [Documentation for PR #11447](docs-pr11447/) (built from [59b7f74](https://github.com/cvc5/cvc5/commit/59b7f74) @ [PR #11447](https://github.com/cvc5/cvc5/pull/11447), 21 hours ago)
* [Documentation for PR #11236](docs-pr11236/) (built from [d389c89](https://github.com/cvc5/cvc5/commit/d389c89) @ [PR #11236](https://github.com/cvc5/cvc5/pull/11236), 3 days ago)
1 change: 1 addition & 0 deletions docs-pr11578
154 changes: 154 additions & 0 deletions docs-pr11578-91f225ab0581a7f50569dc1c9c25bb31263190d1/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=b86133f3" />
<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 2025, 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 7300538

Please sign in to comment.