Skip to content

Commit

Permalink
deploy: 5155867
Browse files Browse the repository at this point in the history
  • Loading branch information
ryanmrichard committed Dec 7, 2023
1 parent dd4dd75 commit 62fce8e
Show file tree
Hide file tree
Showing 59 changed files with 1,102 additions and 806 deletions.
2 changes: 1 addition & 1 deletion .buildinfo
Original file line number Diff line number Diff line change
@@ -1,4 +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: e59634be9fe8d34de2f02696d2a62c9f
config: 293e6e882ec4fe17e03197a6f3713b3c
tags: 645f666f9bcd5a90fca523b33c5a78b7
15 changes: 15 additions & 0 deletions _sources/developer/cmake/get_cmaize.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@

################
cmake.get_cmaize
################

.. module:: cmake.get_cmaize


.. function:: get_cmaize()


.. note:: This is a macro, and so does not introduce a new scope.



15 changes: 0 additions & 15 deletions _sources/developer/cmake/get_cpp.rst.txt

This file was deleted.

3 changes: 2 additions & 1 deletion _sources/developer/cmake/index.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,9 @@ cmake

cminx
find_python_module
get_cmaize
get_cmake_test
get_cpp
get_version_from_git
python_virt_env
versions

7 changes: 7 additions & 0 deletions _sources/developer/cmake/versions.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@

##############
cmake.versions
##############

.. module:: cmake.versions

22 changes: 22 additions & 0 deletions _static/basic.css
Original file line number Diff line number Diff line change
Expand Up @@ -237,6 +237,10 @@ a.headerlink {
visibility: hidden;
}

a:visited {
color: #551A8B;
}

h1:hover > a.headerlink,
h2:hover > a.headerlink,
h3:hover > a.headerlink,
Expand Down Expand Up @@ -670,6 +674,16 @@ dd {
margin-left: 30px;
}

.sig dd {
margin-top: 0px;
margin-bottom: 0px;
}

.sig dl {
margin-top: 0px;
margin-bottom: 0px;
}

dl > dd:last-child,
dl > dd:last-child > :last-child {
margin-bottom: 0;
Expand Down Expand Up @@ -738,6 +752,14 @@ abbr, acronym {
cursor: help;
}

.translated {
background-color: rgba(207, 255, 207, 0.2)
}

.untranslated {
background-color: rgba(255, 207, 207, 0.2)
}

/* -- code displays --------------------------------------------------------- */

pre {
Expand Down
2 changes: 1 addition & 1 deletion _static/css/theme.css

Large diffs are not rendered by default.

5 changes: 2 additions & 3 deletions _static/documentation_options.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
var DOCUMENTATION_OPTIONS = {
URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'),
VERSION: 'v1.1.8',
const DOCUMENTATION_OPTIONS = {
VERSION: 'v1.1.9',
LANGUAGE: 'en',
COLLAPSE_INDEX: false,
BUILDER: 'html',
Expand Down
1 change: 1 addition & 0 deletions _static/pygments.css
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ span.linenos.special { color: #000000; background-color: #ffffc0; padding-left:
.highlight .cs { color: #408090; background-color: #fff0f0 } /* Comment.Special */
.highlight .gd { color: #A00000 } /* Generic.Deleted */
.highlight .ge { font-style: italic } /* Generic.Emph */
.highlight .ges { font-weight: bold; font-style: italic } /* Generic.EmphStrong */
.highlight .gr { color: #FF0000 } /* Generic.Error */
.highlight .gh { color: #000080; font-weight: bold } /* Generic.Heading */
.highlight .gi { color: #00A000 } /* Generic.Inserted */
Expand Down
26 changes: 17 additions & 9 deletions _static/searchtools.js
Original file line number Diff line number Diff line change
Expand Up @@ -57,12 +57,12 @@ const _removeChildren = (element) => {
const _escapeRegExp = (string) =>
string.replace(/[.*+\-?^${}()|[\]\\]/g, "\\$&"); // $& means the whole matched string

const _displayItem = (item, searchTerms) => {
const _displayItem = (item, searchTerms, highlightTerms) => {
const docBuilder = DOCUMENTATION_OPTIONS.BUILDER;
const docUrlRoot = DOCUMENTATION_OPTIONS.URL_ROOT;
const docFileSuffix = DOCUMENTATION_OPTIONS.FILE_SUFFIX;
const docLinkSuffix = DOCUMENTATION_OPTIONS.LINK_SUFFIX;
const showSearchSummary = DOCUMENTATION_OPTIONS.SHOW_SEARCH_SUMMARY;
const contentRoot = document.documentElement.dataset.content_root;

const [docName, title, anchor, descr, score, _filename] = item;

Expand All @@ -75,20 +75,24 @@ const _displayItem = (item, searchTerms) => {
if (dirname.match(/\/index\/$/))
dirname = dirname.substring(0, dirname.length - 6);
else if (dirname === "index/") dirname = "";
requestUrl = docUrlRoot + dirname;
requestUrl = contentRoot + dirname;
linkUrl = requestUrl;
} else {
// normal html builders
requestUrl = docUrlRoot + docName + docFileSuffix;
requestUrl = contentRoot + docName + docFileSuffix;
linkUrl = docName + docLinkSuffix;
}
let linkEl = listItem.appendChild(document.createElement("a"));
linkEl.href = linkUrl + anchor;
linkEl.dataset.score = score;
linkEl.innerHTML = title;
if (descr)
if (descr) {
listItem.appendChild(document.createElement("span")).innerHTML =
" (" + descr + ")";
// highlight search terms in the description
if (SPHINX_HIGHLIGHT_ENABLED) // set in sphinx_highlight.js
highlightTerms.forEach((term) => _highlightText(listItem, term, "highlighted"));
}
else if (showSearchSummary)
fetch(requestUrl)
.then((responseData) => responseData.text())
Expand All @@ -97,6 +101,9 @@ const _displayItem = (item, searchTerms) => {
listItem.appendChild(
Search.makeSearchSummary(data, searchTerms)
);
// highlight search terms in the summary
if (SPHINX_HIGHLIGHT_ENABLED) // set in sphinx_highlight.js
highlightTerms.forEach((term) => _highlightText(listItem, term, "highlighted"));
});
Search.output.appendChild(listItem);
};
Expand All @@ -115,14 +122,15 @@ const _finishSearch = (resultCount) => {
const _displayNextItem = (
results,
resultCount,
searchTerms
searchTerms,
highlightTerms,
) => {
// results left, load the summary and display it
// this is intended to be dynamic (don't sub resultsCount)
if (results.length) {
_displayItem(results.pop(), searchTerms);
_displayItem(results.pop(), searchTerms, highlightTerms);
setTimeout(
() => _displayNextItem(results, resultCount, searchTerms),
() => _displayNextItem(results, resultCount, searchTerms, highlightTerms),
5
);
}
Expand Down Expand Up @@ -360,7 +368,7 @@ const Search = {
// console.info("search results:", Search.lastresults);

// print the results
_displayNextItem(results, results.length, searchTerms);
_displayNextItem(results, results.length, searchTerms, highlightTerms);
},

/**
Expand Down
16 changes: 13 additions & 3 deletions _static/sphinx_highlight.js
Original file line number Diff line number Diff line change
Expand Up @@ -29,14 +29,19 @@ const _highlight = (node, addItems, text, className) => {
}

span.appendChild(document.createTextNode(val.substr(pos, text.length)));
const rest = document.createTextNode(val.substr(pos + text.length));
parent.insertBefore(
span,
parent.insertBefore(
document.createTextNode(val.substr(pos + text.length)),
rest,
node.nextSibling
)
);
node.nodeValue = val.substr(0, pos);
/* There may be more occurrences of search term in this node. So call this
* function recursively on the remaining fragment.
*/
_highlight(rest, addItems, text, className);

if (isInSVG) {
const rect = document.createElementNS(
Expand Down Expand Up @@ -140,5 +145,10 @@ const SphinxHighlight = {
},
};

_ready(SphinxHighlight.highlightSearchWords);
_ready(SphinxHighlight.initEscapeListener);
_ready(() => {
/* Do not call highlightSearchWords() when we are on the search page.
* It will highlight words from the *previous* search query.
*/
if (typeof Search === "undefined") SphinxHighlight.highlightSearchWords();
SphinxHighlight.initEscapeListener();
});
38 changes: 20 additions & 18 deletions about.html
Original file line number Diff line number Diff line change
@@ -1,21 +1,23 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<html class="writer-html5" lang="en" data-content_root="./">
<head>
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
<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>CMinx Background &mdash; CMinx v1.1.8 documentation</title>
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<title>CMinx Background &mdash; CMinx v1.1.9 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"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/sphinx_highlight.js"></script>
<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=80dc2558"></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="author" title="About these documents" href="#" />
<link rel="index" title="Index" href="genindex.html" />
Expand All @@ -36,7 +38,7 @@
CMinx
</a>
<div class="version">
1.1.8
1.1.9
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
Expand Down Expand Up @@ -92,11 +94,11 @@
<div itemprop="articleBody">

<section id="cminx-background">
<h1>CMinx Background<a class="headerlink" href="#cminx-background" title="Permalink to this heading"></a></h1>
<h1>CMinx Background<a class="headerlink" href="#cminx-background" title="Link to this heading"></a></h1>
<p>This page is meant to provide historical background about documenting CMake
modules and the creation of the CMinx project.</p>
<section id="the-official-solution">
<h2>The Official Solution<a class="headerlink" href="#the-official-solution" title="Permalink to this heading"></a></h2>
<h2>The Official Solution<a class="headerlink" href="#the-official-solution" title="Link to this heading"></a></h2>
<p>A user, <code class="docutils literal notranslate"><span class="pre">tjwrona1992</span></code>, asked on
<a class="reference external" href="https://stackoverflow.com/q/54660549">StackOverflow</a> how to get their
custom CMake module’s documentation to show up using the <code class="docutils literal notranslate"><span class="pre">cmake</span> <span class="pre">--help-module</span></code>
Expand Down Expand Up @@ -131,10 +133,10 @@ <h2>The Official Solution<a class="headerlink" href="#the-official-solution" tit
signatures of the functions, the variable names, <em>etc.</em>).</p>
</section>
<section id="sphinx-domain-solutions">
<h2>Sphinx Domain Solutions<a class="headerlink" href="#sphinx-domain-solutions" title="Permalink to this heading"></a></h2>
<h2>Sphinx Domain Solutions<a class="headerlink" href="#sphinx-domain-solutions" title="Link to this heading"></a></h2>
<p>Sphinx domains are a way to package up language-specific directives, and roles.</p>
<section id="sphinx-s-unofficial-cmake-domain">
<h3>Sphinx’s (Unofficial) CMake Domain<a class="headerlink" href="#sphinx-s-unofficial-cmake-domain" title="Permalink to this heading"></a></h3>
<h3>Sphinx’s (Unofficial) CMake Domain<a class="headerlink" href="#sphinx-s-unofficial-cmake-domain" title="Link to this heading"></a></h3>
<p><a class="reference external" href="https://github.com/sphinx-contrib/cmakedomain">link</a></p>
<p>Started (and finished) on 10/21/2013, this is the official (unofficial) CMake
domain for Sphinx. The actual domain is pretty bare bones providing:</p>
Expand All @@ -158,7 +160,7 @@ <h3>Sphinx’s (Unofficial) CMake Domain<a class="headerlink" href="#sphinx-s-un
<p>In summary, it feels safe to say that this repo has been abandoned.</p>
</section>
<section id="scikit-build-modern-cmake-domain">
<h3>scikit-build Modern CMake Domain<a class="headerlink" href="#scikit-build-modern-cmake-domain" title="Permalink to this heading"></a></h3>
<h3>scikit-build Modern CMake Domain<a class="headerlink" href="#scikit-build-modern-cmake-domain" title="Link to this heading"></a></h3>
<p><a class="reference external" href="https://github.com/scikit-build/moderncmakedomain">link</a></p>
<p>Started on 10/14/2018 by GitHub user <code class="docutils literal notranslate"><span class="pre">bruxisma</span></code>, and acquired by scikit-build
in August of 20201, this project hosts a mirror of the CMake domain Kitware
Expand All @@ -183,7 +185,7 @@ <h3>scikit-build Modern CMake Domain<a class="headerlink" href="#scikit-build-mo
</ul>
</section>
<section id="marcokoch-cmake-domain">
<h3>MarcoKoch CMake Domain<a class="headerlink" href="#marcokoch-cmake-domain" title="Permalink to this heading"></a></h3>
<h3>MarcoKoch CMake Domain<a class="headerlink" href="#marcokoch-cmake-domain" title="Link to this heading"></a></h3>
<p><a class="reference external" href="https://github.com/MarcoKoch/sphinx-cmake_domain">link</a></p>
<p>Started on 7/7/2020, and developed seemingly independent of scikit-build’s CMake
domain. Supports:</p>
Expand All @@ -208,7 +210,7 @@ <h3>MarcoKoch CMake Domain<a class="headerlink" href="#marcokoch-cmake-domain" t
</section>
</section>
<section id="cminx">
<h2>CMinx<a class="headerlink" href="#cminx" title="Permalink to this heading"></a></h2>
<h2>CMinx<a class="headerlink" href="#cminx" title="Link to this heading"></a></h2>
<p>Started 8/26/2019. CMinx is envisioned as a Doxygen-like solution to
documenting CMake modules. This means that CMinx is run on your source directory
and in return generates the reST files for you.</p>
Expand Down
Loading

0 comments on commit 62fce8e

Please sign in to comment.