-
Notifications
You must be signed in to change notification settings - Fork 11
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
8cc0fb6
commit d425de4
Showing
11 changed files
with
222 additions
and
5 deletions.
There are no files selected for viewing
25 changes: 25 additions & 0 deletions
25
...eveloper/cmaize/user_api/dependencies/find_or_build_optional_dependency.rst.txt
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,25 @@ | ||
|
|
||
| ############################################################## | ||
| cmaize.user_api/dependencies/find_or_build_optional_dependency | ||
| ############################################################## | ||
|
|
||
| .. module:: cmaize.user_api/dependencies/find_or_build_optional_dependency | ||
|
|
||
|
|
||
| .. function:: cmaize_find_or_build_optional_dependency(_cfobod_name _cfobod_flag) | ||
|
|
||
| Wraps the process of finding, or building, an optional dependency. | ||
|
|
||
| This method is largely the same as cmaize_find_optional_dependency, but | ||
| instead wraps a call to ``cmaize_find_or_build_dependency``. | ||
|
|
||
| :param name: The name of the dependency. | ||
| :type name: desc | ||
| :param flag: The variable to use as a flag. Used to name the compile | ||
| definition. | ||
| :type flag: desc | ||
| :param kwargs: Keyword arguments to forward to | ||
| ``cmaize_find_or_build_dependency``. See the documentation for | ||
| ``cmaize_find_or_build_dependency`` for the full list. | ||
|
|
||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
170 changes: 170 additions & 0 deletions
170
api/developer/cmaize/user_api/dependencies/find_or_build_optional_dependency.html
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,170 @@ | ||
| <!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>cmaize.user_api/dependencies/find_or_build_optional_dependency — CMaize 1.0.0 documentation</title> | ||
| <link rel="stylesheet" type="text/css" href="../../../../../_static/pygments.css?v=fa44fd50" /> | ||
| <link rel="stylesheet" type="text/css" href="../../../../../_static/css/theme.css?v=19f00094" /> | ||
|
|
||
|
|
||
| <!--[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=8d563738"></script> | ||
| <script src="../../../../../_static/doctools.js?v=888ff710"></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="cmaize.user_api/add_executable" href="../add_executable.html" /> | ||
| <link rel="prev" title="cmaize.user_api/dependencies/find_or_build_dependency" href="find_or_build_dependency.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/logo.png" class="logo" alt="Logo"/> | ||
| </a> | ||
| <div class="version"> | ||
| 1.0.0 | ||
| </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 class="current"> | ||
| <li class="toctree-l1"><a class="reference internal" href="../../../../../overview.html">Overview</a></li> | ||
| <li class="toctree-l1"><a class="reference internal" href="../../../../../background/index.html">CMaize Background</a></li> | ||
| <li class="toctree-l1"><a class="reference internal" href="../../../../../getting_started/index.html">Getting Started</a></li> | ||
| <li class="toctree-l1 current"><a class="reference internal" href="../../../../index.html">API</a><ul class="current"> | ||
| <li class="toctree-l2 current"><a class="reference internal" href="../../index.html">Refactored Developer API (in progress)</a><ul class="current"> | ||
| <li class="toctree-l3"><a class="reference internal" href="../../package_managers/index.html">cmaize.package_managers</a></li> | ||
| <li class="toctree-l3"><a class="reference internal" href="../../project/index.html">cmaize.project</a></li> | ||
| <li class="toctree-l3"><a class="reference internal" href="../../targets/index.html">cmaize.targets</a></li> | ||
| <li class="toctree-l3"><a class="reference internal" href="../../toolchain/index.html">cmaize.toolchain</a></li> | ||
| <li class="toctree-l3 current"><a class="reference internal" href="../index.html">cmaize.user_api</a><ul class="current"> | ||
| <li class="toctree-l4 current"><a class="reference internal" href="index.html">cmaize.user_api/dependencies</a></li> | ||
| <li class="toctree-l4"><a class="reference internal" href="../add_executable.html">cmaize.user_api/add_executable</a></li> | ||
| <li class="toctree-l4"><a class="reference internal" href="../add_library.html">cmaize.user_api/add_library</a></li> | ||
| <li class="toctree-l4"><a class="reference internal" href="../add_package.html">cmaize.user_api/add_package</a></li> | ||
| <li class="toctree-l4"><a class="reference internal" href="../add_tests.html">cmaize.user_api/add_tests</a></li> | ||
| <li class="toctree-l4"><a class="reference internal" href="../cmaize_option.html">cmaize.user_api/cmaize_option</a></li> | ||
| <li class="toctree-l4"><a class="reference internal" href="../cmaize_project.html">cmaize.user_api/cmaize_project</a></li> | ||
| <li class="toctree-l4"><a class="reference internal" href="../user_api.html">cmaize.user_api/user_api</a></li> | ||
| </ul> | ||
| </li> | ||
| <li class="toctree-l3"><a class="reference internal" href="../../utilities/index.html">cmaize.utilities</a></li> | ||
| <li class="toctree-l3"><a class="reference internal" href="../../cmaize.html">cmaize.cmaize</a></li> | ||
| <li class="toctree-l3"><a class="reference internal" href="../../cmaize_impl.html">cmaize.cmaize_impl</a></li> | ||
| <li class="toctree-l3"><a class="reference internal" href="../../globals.html">cmaize.globals</a></li> | ||
| </ul> | ||
| </li> | ||
| </ul> | ||
| </li> | ||
| <li class="toctree-l1"><a class="reference internal" href="../../../../../developer/index.html">Developing CMaize</a></li> | ||
| <li class="toctree-l1"><a class="reference internal" href="../../../../../declaring_targets/index.html">Declaring Build Targets</a></li> | ||
| <li class="toctree-l1"><a class="reference internal" href="../../../../../dependencies/index.html">Declaring Dependencies</a></li> | ||
| <li class="toctree-l1"><a class="reference internal" href="../../../../../bibliography/bibliography.html">References</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">CMaize</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"><a href="../../../../index.html">API</a></li> | ||
| <li class="breadcrumb-item"><a href="../../index.html">cmaize</a></li> | ||
| <li class="breadcrumb-item"><a href="../index.html">cmaize.user_api</a></li> | ||
| <li class="breadcrumb-item"><a href="index.html">cmaize.user_api/dependencies</a></li> | ||
| <li class="breadcrumb-item active">cmaize.user_api/dependencies/find_or_build_optional_dependency</li> | ||
| <li class="wy-breadcrumbs-aside"> | ||
| <a href="https://github.com/CMakePP/CMaize/edit/master/docs/source/api/developer/cmaize/user_api/dependencies/find_or_build_optional_dependency.rst" class="fa fa-github"> Edit on GitHub</a> | ||
| </li> | ||
| </ul> | ||
| <hr/> | ||
| </div> | ||
| <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> | ||
| <div itemprop="articleBody"> | ||
|
|
||
| <section id="module-cmaize.user_api-dependencies-find_or_build_optional_dependency"> | ||
| <span id="cmaize-user-api-dependencies-find-or-build-optional-dependency"></span><h1>cmaize.user_api/dependencies/find_or_build_optional_dependency<a class="headerlink" href="#module-cmaize.user_api-dependencies-find_or_build_optional_dependency" title="Link to this heading"></a></h1> | ||
| <dl class="py function"> | ||
| <dt class="sig sig-object py" id="cmaize.user_api-dependencies-find_or_build_optional_dependency.cmaize_find_or_build_optional_dependency"> | ||
| <span class="sig-prename descclassname"><span class="pre">cmaize.user_api/dependencies/find_or_build_optional_dependency.</span></span><span class="sig-name descname"><span class="pre">cmaize_find_or_build_optional_dependency</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_cfobod_name</span> <span class="pre">_cfobod_flag</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cmaize.user_api-dependencies-find_or_build_optional_dependency.cmaize_find_or_build_optional_dependency" title="Link to this definition"></a></dt> | ||
| <dd><p>Wraps the process of finding, or building, an optional dependency.</p> | ||
| <p>This method is largely the same as cmaize_find_optional_dependency, but | ||
| instead wraps a call to <code class="docutils literal notranslate"><span class="pre">cmaize_find_or_build_dependency</span></code>.</p> | ||
| <dl class="field-list simple"> | ||
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> | ||
| <dd class="field-odd"><ul class="simple"> | ||
| <li><p><strong>name</strong> (<em>desc</em>) – The name of the dependency.</p></li> | ||
| <li><p><strong>flag</strong> (<em>desc</em>) – The variable to use as a flag. Used to name the compile | ||
| definition.</p></li> | ||
| <li><p><strong>kwargs</strong> – Keyword arguments to forward to | ||
| <code class="docutils literal notranslate"><span class="pre">cmaize_find_or_build_dependency</span></code>. See the documentation for | ||
| <code class="docutils literal notranslate"><span class="pre">cmaize_find_or_build_dependency</span></code> for the full list.</p></li> | ||
| </ul> | ||
| </dd> | ||
| </dl> | ||
| </dd></dl> | ||
|
|
||
| </section> | ||
|
|
||
|
|
||
| </div> | ||
| </div> | ||
| <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer"> | ||
| <a href="find_or_build_dependency.html" class="btn btn-neutral float-left" title="cmaize.user_api/dependencies/find_or_build_dependency" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a> | ||
| <a href="../add_executable.html" class="btn btn-neutral float-right" title="cmaize.user_api/add_executable" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a> | ||
| </div> | ||
|
|
||
| <hr/> | ||
|
|
||
| <div role="contentinfo"> | ||
| <p>© Copyright 2020, CMakePP Team.</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> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Binary file not shown.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Large diffs are not rendered by default.
Oops, something went wrong.