Skip to content

Commit

Permalink
Update gh-pages to output generated at 8c40210
Browse files Browse the repository at this point in the history
  • Loading branch information
braxtons12 committed Feb 29, 2024
1 parent cc1ad88 commit b28f9d1
Show file tree
Hide file tree
Showing 3 changed files with 15 additions and 18 deletions.
17 changes: 8 additions & 9 deletions _sources/quick_start.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -29,15 +29,15 @@ other methods like :cmake:`add_subdirectory`\. Example for :cmake:`FetchContent`
Note that hyperion::mpl depends on
`hyperion::platform <https://github.com/braxtons12/hyperion_platform>`_ for platform and feature
detection macros and other core utilities, and `doctest <https://github.com/doctest/doctestdoctest>`_
for runtime testing. `hyperion::platform <https://github.com/braxtons12/hyperion_platform>`_
optionally depends on `Tracy <https://github.com/wolfpld/tracy>`_ for the profiling macros it wraps
in :cpp:`#include <hyperion/platform/def.h>`\. Inclusion of this dependency can be configured by
setting the option :cmake:`HYPERION_ENABLE_TRACY` to :cmake:`ON` or :cmake:`OFF`\.
detection macros and other core utilities. `hyperion::platform <https://github.com/braxtons12/hyperion_platform>`_
has several optional features with optional dependencies, and hyperion::mpl exposes those settings
to its users as well (see the
`hyperion::platform documentation <https://braxtons12.github.io/hyperion_platform/quick_start.html>`_
for how to enable these).

By default, :cmake:`FetchContent` will be used to obtain these dependencies, but you can disable
this by setting :cmake:`HYPERION_USE_FETCH_CONTENT` to :cmake:`OFF`\, in which case you will need to
make sure each package is findable via CMake's :cmake:`find_package`.
make sure each package is findable via CMake's :cmake:`find_package`\.

XMake
-----
Expand Down Expand Up @@ -70,6 +70,5 @@ way to use Hyperion packages. Example:
Note that with XMake, hyperion::mpl requires the same dependencies as with the CMake build system.
Third-party dependencies will be pulled from xmake-repo, the package repository/registry for XMake,
and dependencies on other hyperion libraries will be pulled from github via the
`hyperion package repository/registry for xmake <https://github.com/braxtons12/hyperion_packages>`_.
As with CMake, you can enable or disable Tracy (defaults to off) by setting the option
:bash:`hyperion_enable_tracy`
`hyperion package repository/registry for xmake <https://github.com/braxtons12/hyperion_packages>`_\.

14 changes: 6 additions & 8 deletions quick_start.html
Original file line number Diff line number Diff line change
Expand Up @@ -597,11 +597,11 @@ <h2>CMake<a class="headerlink" href="#cmake" title="Link to this heading">#</a><
</div>
<p>Note that hyperion::mpl depends on
<a class="reference external" href="https://github.com/braxtons12/hyperion_platform">hyperion::platform</a> for platform and feature
detection macros and other core utilities, and <a class="reference external" href="https://github.com/doctest/doctestdoctest">doctest</a>
for runtime testing. <a class="reference external" href="https://github.com/braxtons12/hyperion_platform">hyperion::platform</a>
optionally depends on <a class="reference external" href="https://github.com/wolfpld/tracy">Tracy</a> for the profiling macros it wraps
in <code class="code highlight cpp docutils literal highlight-cpp"><span class="cp">#include</span><span class="w"> </span><span class="cpf">&lt;hyperion/platform/def.h&gt;</span></code>. Inclusion of this dependency can be configured by
setting the option <code class="code highlight cmake docutils literal highlight-cmake"><span class="err">HYPERION_ENABLE_TRACY</span></code> to <code class="code highlight cmake docutils literal highlight-cmake"><span class="err">ON</span></code> or <code class="code highlight cmake docutils literal highlight-cmake"><span class="err">OFF</span></code>.</p>
detection macros and other core utilities. <a class="reference external" href="https://github.com/braxtons12/hyperion_platform">hyperion::platform</a>
has several optional features with optional dependencies, and hyperion::mpl exposes those settings
to its users as well (see the
<a class="reference external" href="https://braxtons12.github.io/hyperion_platform/quick_start.html">hyperion::platform documentation</a>
for how to enable these).</p>
<p>By default, <code class="code highlight cmake docutils literal highlight-cmake"><span class="err">FetchContent</span></code> will be used to obtain these dependencies, but you can disable
this by setting <code class="code highlight cmake docutils literal highlight-cmake"><span class="err">HYPERION_USE_FETCH_CONTENT</span></code> to <code class="code highlight cmake docutils literal highlight-cmake"><span class="err">OFF</span></code>, in which case you will need to
make sure each package is findable via CMake’s <code class="code highlight cmake docutils literal highlight-cmake"><span class="err">find_package</span></code>.</p>
Expand Down Expand Up @@ -635,9 +635,7 @@ <h2>XMake<a class="headerlink" href="#xmake" title="Link to this heading">#</a><
<p>Note that with XMake, hyperion::mpl requires the same dependencies as with the CMake build system.
Third-party dependencies will be pulled from xmake-repo, the package repository/registry for XMake,
and dependencies on other hyperion libraries will be pulled from github via the
<a class="reference external" href="https://github.com/braxtons12/hyperion_packages">hyperion package repository/registry for xmake</a>.
As with CMake, you can enable or disable Tracy (defaults to off) by setting the option
<code class="code highlight bash docutils literal highlight-bash">hyperion_enable_tracy</code></p>
<a class="reference external" href="https://github.com/braxtons12/hyperion_packages">hyperion package repository/registry for xmake</a>.</p>
</section>
</section>

Expand Down
2 changes: 1 addition & 1 deletion searchindex.js

Large diffs are not rendered by default.

0 comments on commit b28f9d1

Please sign in to comment.