From 7f912cfe192a95eaca7366968c97f3b0692ece4a Mon Sep 17 00:00:00 2001 From: ryanmrichard Date: Thu, 8 Aug 2024 13:35:28 +0000 Subject: [PATCH] deploy: 32f8157004386c968d533eb79b1fc8516d20fcd5 --- .buildinfo | 2 +- _static/basic.css | 2 +- _static/doctools.js | 2 +- _static/documentation_options.js | 2 +- _static/language_data.js | 4 +- _static/searchtools.js | 170 +++++++++++------- about.html | 10 +- config.html | 10 +- developer/.autosummary/cminx.aggregator.html | 10 +- developer/.autosummary/cminx.config.html | 10 +- developer/.autosummary/cminx.document.html | 10 +- .../cminx.document_single_file.html | 10 +- .../cminx.documentation_types.html | 10 +- developer/.autosummary/cminx.documenter.html | 10 +- developer/.autosummary/cminx.exceptions.html | 10 +- developer/.autosummary/cminx.main.html | 10 +- .../.autosummary/cminx.parser.CMakeLexer.html | 10 +- .../cminx.parser.CMakeListener.html | 10 +- .../cminx.parser.CMakeParser.html | 10 +- .../cminx.parser.CMakeVisitor.html | 10 +- developer/.autosummary/cminx.rstwriter.html | 10 +- developer/api.html | 10 +- developer/ci.html | 10 +- developer/cmake/cminx.html | 10 +- developer/cmake/find_python_module.html | 10 +- developer/cmake/get_cmaize.html | 10 +- developer/cmake/get_cmake_test.html | 10 +- developer/cmake/get_version_from_git.html | 10 +- developer/cmake/index.html | 10 +- developer/cmake/python_virt_env.html | 10 +- developer/cmake/versions.html | 10 +- developer/dependencies.html | 10 +- developer/documentation.html | 10 +- developer/index.html | 10 +- developer/overview.html | 10 +- developer/repo_structure.html | 10 +- documenting/cmaketest.html | 10 +- documenting/ctest_add_test.html | 10 +- documenting/function.html | 10 +- documenting/index.html | 10 +- documenting/macro.html | 10 +- documenting/module.html | 10 +- documenting/types_of_comments.html | 10 +- documenting/variable.html | 10 +- full_example.html | 18 +- genindex.html | 10 +- index.html | 10 +- installation.html | 10 +- objects.inv | Bin 2493 -> 2494 bytes py-modindex.html | 10 +- quickstart.html | 10 +- search.html | 10 +- searchindex.js | 2 +- usage.html | 10 +- 54 files changed, 349 insertions(+), 303 deletions(-) diff --git a/.buildinfo b/.buildinfo index e766afa6..7d469fb8 100644 --- a/.buildinfo +++ b/.buildinfo @@ -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: 293e6e882ec4fe17e03197a6f3713b3c +config: 2ba27826f6c0659bb79fabdb2e9bdda1 tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/_static/basic.css b/_static/basic.css index 30fee9d0..f316efcb 100644 --- a/_static/basic.css +++ b/_static/basic.css @@ -4,7 +4,7 @@ * * Sphinx stylesheet -- basic theme. * - * :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS. + * :copyright: Copyright 2007-2024 by the Sphinx team, see AUTHORS. * :license: BSD, see LICENSE for details. * */ diff --git a/_static/doctools.js b/_static/doctools.js index d06a71d7..4d67807d 100644 --- a/_static/doctools.js +++ b/_static/doctools.js @@ -4,7 +4,7 @@ * * Base JavaScript utilities for all Sphinx HTML documentation. * - * :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS. + * :copyright: Copyright 2007-2024 by the Sphinx team, see AUTHORS. * :license: BSD, see LICENSE for details. * */ diff --git a/_static/documentation_options.js b/_static/documentation_options.js index 403f4289..bccd9e6f 100644 --- a/_static/documentation_options.js +++ b/_static/documentation_options.js @@ -1,5 +1,5 @@ const DOCUMENTATION_OPTIONS = { - VERSION: 'v1.1.9', + VERSION: 'v1.1.10', LANGUAGE: 'en', COLLAPSE_INDEX: false, BUILDER: 'html', diff --git a/_static/language_data.js b/_static/language_data.js index 250f5665..367b8ed8 100644 --- a/_static/language_data.js +++ b/_static/language_data.js @@ -5,7 +5,7 @@ * This script contains the language-specific data used by searchtools.js, * namely the list of stopwords, stemmer, scorer and splitter. * - * :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS. + * :copyright: Copyright 2007-2024 by the Sphinx team, see AUTHORS. * :license: BSD, see LICENSE for details. * */ @@ -13,7 +13,7 @@ var stopwords = ["a", "and", "are", "as", "at", "be", "but", "by", "for", "if", "in", "into", "is", "it", "near", "no", "not", "of", "on", "or", "such", "that", "the", "their", "then", "there", "these", "they", "this", "to", "was", "will", "with"]; -/* Non-minified version is copied as a separate JS file, is available */ +/* Non-minified version is copied as a separate JS file, if available */ /** * Porter Stemmer diff --git a/_static/searchtools.js b/_static/searchtools.js index 7918c3fa..b08d58c9 100644 --- a/_static/searchtools.js +++ b/_static/searchtools.js @@ -4,7 +4,7 @@ * * Sphinx JavaScript utilities for the full-text search. * - * :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS. + * :copyright: Copyright 2007-2024 by the Sphinx team, see AUTHORS. * :license: BSD, see LICENSE for details. * */ @@ -99,7 +99,7 @@ const _displayItem = (item, searchTerms, highlightTerms) => { .then((data) => { if (data) listItem.appendChild( - Search.makeSearchSummary(data, searchTerms) + Search.makeSearchSummary(data, searchTerms, anchor) ); // highlight search terms in the summary if (SPHINX_HIGHLIGHT_ENABLED) // set in sphinx_highlight.js @@ -116,8 +116,8 @@ const _finishSearch = (resultCount) => { ); else Search.status.innerText = _( - `Search finished, found ${resultCount} page(s) matching the search query.` - ); + "Search finished, found ${resultCount} page(s) matching the search query." + ).replace('${resultCount}', resultCount); }; const _displayNextItem = ( results, @@ -137,6 +137,22 @@ const _displayNextItem = ( // search finished, update title and status message else _finishSearch(resultCount); }; +// Helper function used by query() to order search results. +// Each input is an array of [docname, title, anchor, descr, score, filename]. +// Order the results by score (in opposite order of appearance, since the +// `_displayNextItem` function uses pop() to retrieve items) and then alphabetically. +const _orderResultsByScoreThenName = (a, b) => { + const leftScore = a[4]; + const rightScore = b[4]; + if (leftScore === rightScore) { + // same score: sort alphabetically + const leftTitle = a[1].toLowerCase(); + const rightTitle = b[1].toLowerCase(); + if (leftTitle === rightTitle) return 0; + return leftTitle > rightTitle ? -1 : 1; // inverted is intentional + } + return leftScore > rightScore ? 1 : -1; +}; /** * Default splitQuery function. Can be overridden in ``sphinx.search`` with a @@ -160,13 +176,26 @@ const Search = { _queued_query: null, _pulse_status: -1, - htmlToText: (htmlString) => { + htmlToText: (htmlString, anchor) => { const htmlElement = new DOMParser().parseFromString(htmlString, 'text/html'); - htmlElement.querySelectorAll(".headerlink").forEach((el) => { el.remove() }); + for (const removalQuery of [".headerlink", "script", "style"]) { + htmlElement.querySelectorAll(removalQuery).forEach((el) => { el.remove() }); + } + if (anchor) { + const anchorContent = htmlElement.querySelector(`[role="main"] ${anchor}`); + if (anchorContent) return anchorContent.textContent; + + console.warn( + `Anchored content block not found. Sphinx search tries to obtain it via DOM query '[role=main] ${anchor}'. Check your theme or template.` + ); + } + + // if anchor not specified or not found, fall back to main content const docContent = htmlElement.querySelector('[role="main"]'); - if (docContent !== undefined) return docContent.textContent; + if (docContent) return docContent.textContent; + console.warn( - "Content block not found. Sphinx search tries to obtain it via '[role=main]'. Could you check your theme or template." + "Content block not found. Sphinx search tries to obtain it via DOM query '[role=main]'. Check your theme or template." ); return ""; }, @@ -239,16 +268,7 @@ const Search = { else Search.deferQuery(query); }, - /** - * execute search (requires search index to be loaded) - */ - query: (query) => { - const filenames = Search._index.filenames; - const docNames = Search._index.docnames; - const titles = Search._index.titles; - const allTitles = Search._index.alltitles; - const indexEntries = Search._index.indexentries; - + _parseQuery: (query) => { // stem the search terms and add them to the correct list const stemmer = new Stemmer(); const searchTerms = new Set(); @@ -284,21 +304,38 @@ const Search = { // console.info("required: ", [...searchTerms]); // console.info("excluded: ", [...excludedTerms]); - // array of [docname, title, anchor, descr, score, filename] - let results = []; + return [query, searchTerms, excludedTerms, highlightTerms, objectTerms]; + }, + + /** + * execute search (requires search index to be loaded) + */ + _performSearch: (query, searchTerms, excludedTerms, highlightTerms, objectTerms) => { + const filenames = Search._index.filenames; + const docNames = Search._index.docnames; + const titles = Search._index.titles; + const allTitles = Search._index.alltitles; + const indexEntries = Search._index.indexentries; + + // Collect multiple result groups to be sorted separately and then ordered. + // Each is an array of [docname, title, anchor, descr, score, filename]. + const normalResults = []; + const nonMainIndexResults = []; + _removeChildren(document.getElementById("search-progress")); - const queryLower = query.toLowerCase(); + const queryLower = query.toLowerCase().trim(); for (const [title, foundTitles] of Object.entries(allTitles)) { - if (title.toLowerCase().includes(queryLower) && (queryLower.length >= title.length/2)) { + if (title.toLowerCase().trim().includes(queryLower) && (queryLower.length >= title.length/2)) { for (const [file, id] of foundTitles) { - let score = Math.round(100 * queryLower.length / title.length) - results.push([ + const score = Math.round(Scorer.title * queryLower.length / title.length); + const boost = titles[file] === title ? 1 : 0; // add a boost for document titles + normalResults.push([ docNames[file], titles[file] !== title ? `${titles[file]} > ${title}` : title, id !== null ? "#" + id : "", null, - score, + score + boost, filenames[file], ]); } @@ -308,46 +345,47 @@ const Search = { // search for explicit entries in index directives for (const [entry, foundEntries] of Object.entries(indexEntries)) { if (entry.includes(queryLower) && (queryLower.length >= entry.length/2)) { - for (const [file, id] of foundEntries) { - let score = Math.round(100 * queryLower.length / entry.length) - results.push([ + for (const [file, id, isMain] of foundEntries) { + const score = Math.round(100 * queryLower.length / entry.length); + const result = [ docNames[file], titles[file], id ? "#" + id : "", null, score, filenames[file], - ]); + ]; + if (isMain) { + normalResults.push(result); + } else { + nonMainIndexResults.push(result); + } } } } // lookup as object objectTerms.forEach((term) => - results.push(...Search.performObjectSearch(term, objectTerms)) + normalResults.push(...Search.performObjectSearch(term, objectTerms)) ); // lookup as search terms in fulltext - results.push(...Search.performTermsSearch(searchTerms, excludedTerms)); + normalResults.push(...Search.performTermsSearch(searchTerms, excludedTerms)); // let the scorer override scores with a custom scoring function - if (Scorer.score) results.forEach((item) => (item[4] = Scorer.score(item))); - - // now sort the results by score (in opposite order of appearance, since the - // display function below uses pop() to retrieve items) and then - // alphabetically - results.sort((a, b) => { - const leftScore = a[4]; - const rightScore = b[4]; - if (leftScore === rightScore) { - // same score: sort alphabetically - const leftTitle = a[1].toLowerCase(); - const rightTitle = b[1].toLowerCase(); - if (leftTitle === rightTitle) return 0; - return leftTitle > rightTitle ? -1 : 1; // inverted is intentional - } - return leftScore > rightScore ? 1 : -1; - }); + if (Scorer.score) { + normalResults.forEach((item) => (item[4] = Scorer.score(item))); + nonMainIndexResults.forEach((item) => (item[4] = Scorer.score(item))); + } + + // Sort each group of results by score and then alphabetically by name. + normalResults.sort(_orderResultsByScoreThenName); + nonMainIndexResults.sort(_orderResultsByScoreThenName); + + // Combine the result groups in (reverse) order. + // Non-main index entries are typically arbitrary cross-references, + // so display them after other results. + let results = [...nonMainIndexResults, ...normalResults]; // remove duplicate search results // note the reversing of results, so that in the case of duplicates, the highest-scoring entry is kept @@ -361,7 +399,12 @@ const Search = { return acc; }, []); - results = results.reverse(); + return results.reverse(); + }, + + query: (query) => { + const [searchQuery, searchTerms, excludedTerms, highlightTerms, objectTerms] = Search._parseQuery(query); + const results = Search._performSearch(searchQuery, searchTerms, excludedTerms, highlightTerms, objectTerms); // for debugging //Search.lastresults = results.slice(); // a copy @@ -466,14 +509,18 @@ const Search = { // add support for partial matches if (word.length > 2) { const escapedWord = _escapeRegExp(word); - Object.keys(terms).forEach((term) => { - if (term.match(escapedWord) && !terms[word]) - arr.push({ files: terms[term], score: Scorer.partialTerm }); - }); - Object.keys(titleTerms).forEach((term) => { - if (term.match(escapedWord) && !titleTerms[word]) - arr.push({ files: titleTerms[word], score: Scorer.partialTitle }); - }); + if (!terms.hasOwnProperty(word)) { + Object.keys(terms).forEach((term) => { + if (term.match(escapedWord)) + arr.push({ files: terms[term], score: Scorer.partialTerm }); + }); + } + if (!titleTerms.hasOwnProperty(word)) { + Object.keys(titleTerms).forEach((term) => { + if (term.match(escapedWord)) + arr.push({ files: titleTerms[term], score: Scorer.partialTitle }); + }); + } } // no match but word was a required one @@ -496,9 +543,8 @@ const Search = { // create the mapping files.forEach((file) => { - if (fileMap.has(file) && fileMap.get(file).indexOf(word) === -1) - fileMap.get(file).push(word); - else fileMap.set(file, [word]); + if (!fileMap.has(file)) fileMap.set(file, [word]); + else if (fileMap.get(file).indexOf(word) === -1) fileMap.get(file).push(word); }); }); @@ -549,8 +595,8 @@ const Search = { * search summary for a given text. keywords is a list * of stemmed words. */ - makeSearchSummary: (htmlText, keywords) => { - const text = Search.htmlToText(htmlText); + makeSearchSummary: (htmlText, keywords, anchor) => { + const text = Search.htmlToText(htmlText, anchor); if (text === "") return null; const textLower = text.toLowerCase(); diff --git a/about.html b/about.html index ddce1a6b..44b1848e 100644 --- a/about.html +++ b/about.html @@ -4,7 +4,7 @@ - CMinx Background — CMinx v1.1.9 documentation + CMinx Background — CMinx v1.1.10 documentation @@ -15,8 +15,8 @@ - - + + @@ -38,7 +38,7 @@ CMinx
- 1.1.9 + 1.1.10
@@ -228,7 +228,7 @@

CMinx
-

© Copyright 2023, CMakePP Team.

+

© Copyright 2024, CMakePP Team.

Built with Sphinx using a diff --git a/config.html b/config.html index 0a09ff4f..709057bb 100644 --- a/config.html +++ b/config.html @@ -4,7 +4,7 @@ - Configuring CMinx — CMinx v1.1.9 documentation + Configuring CMinx — CMinx v1.1.10 documentation @@ -15,8 +15,8 @@ - - + + @@ -38,7 +38,7 @@ CMinx
- 1.1.9 + 1.1.10
@@ -347,7 +347,7 @@

Writing a Configuration File -

© Copyright 2023, CMakePP Team.

+

© Copyright 2024, CMakePP Team.

Built with Sphinx using a diff --git a/developer/.autosummary/cminx.aggregator.html b/developer/.autosummary/cminx.aggregator.html index c126d78a..8577e341 100644 --- a/developer/.autosummary/cminx.aggregator.html +++ b/developer/.autosummary/cminx.aggregator.html @@ -4,7 +4,7 @@ - cminx.aggregator — CMinx v1.1.9 documentation + cminx.aggregator — CMinx v1.1.10 documentation @@ -15,8 +15,8 @@ - - + + @@ -38,7 +38,7 @@ CMinx
- 1.1.9 + 1.1.10
@@ -427,7 +427,7 @@
-

© Copyright 2023, CMakePP Team.

+

© Copyright 2024, CMakePP Team.

Built with Sphinx using a diff --git a/developer/.autosummary/cminx.config.html b/developer/.autosummary/cminx.config.html index 770b3398..214e8b71 100644 --- a/developer/.autosummary/cminx.config.html +++ b/developer/.autosummary/cminx.config.html @@ -4,7 +4,7 @@ - cminx.config — CMinx v1.1.9 documentation + cminx.config — CMinx v1.1.10 documentation @@ -15,8 +15,8 @@ - - + + @@ -38,7 +38,7 @@ CMinx
- 1.1.9 + 1.1.10
@@ -161,7 +161,7 @@
-

© Copyright 2023, CMakePP Team.

+

© Copyright 2024, CMakePP Team.

Built with Sphinx using a diff --git a/developer/.autosummary/cminx.document.html b/developer/.autosummary/cminx.document.html index 50ebb069..9c2f98a9 100644 --- a/developer/.autosummary/cminx.document.html +++ b/developer/.autosummary/cminx.document.html @@ -4,7 +4,7 @@ - cminx.document — CMinx v1.1.9 documentation + cminx.document — CMinx v1.1.10 documentation @@ -15,8 +15,8 @@ - - + + @@ -38,7 +38,7 @@ CMinx
- 1.1.9 + 1.1.10
Built with Sphinx using a diff --git a/developer/.autosummary/cminx.document_single_file.html b/developer/.autosummary/cminx.document_single_file.html index 96c76c1b..f2bd382a 100644 --- a/developer/.autosummary/cminx.document_single_file.html +++ b/developer/.autosummary/cminx.document_single_file.html @@ -4,7 +4,7 @@ - cminx.document_single_file — CMinx v1.1.9 documentation + cminx.document_single_file — CMinx v1.1.10 documentation @@ -15,8 +15,8 @@ - - + + @@ -38,7 +38,7 @@ CMinx
- 1.1.9 + 1.1.10
Built with Sphinx using a diff --git a/developer/.autosummary/cminx.documentation_types.html b/developer/.autosummary/cminx.documentation_types.html index 5f83c65e..abcf1146 100644 --- a/developer/.autosummary/cminx.documentation_types.html +++ b/developer/.autosummary/cminx.documentation_types.html @@ -4,7 +4,7 @@ - cminx.documentation_types — CMinx v1.1.9 documentation + cminx.documentation_types — CMinx v1.1.10 documentation @@ -15,8 +15,8 @@ - - + + @@ -38,7 +38,7 @@ CMinx
- 1.1.9 + 1.1.10
@@ -624,7 +624,7 @@
-

© Copyright 2023, CMakePP Team.

+

© Copyright 2024, CMakePP Team.

Built with Sphinx using a diff --git a/developer/.autosummary/cminx.documenter.html b/developer/.autosummary/cminx.documenter.html index dd0c4127..fbf8b168 100644 --- a/developer/.autosummary/cminx.documenter.html +++ b/developer/.autosummary/cminx.documenter.html @@ -4,7 +4,7 @@ - cminx.documenter — CMinx v1.1.9 documentation + cminx.documenter — CMinx v1.1.10 documentation @@ -15,8 +15,8 @@ - - + + @@ -38,7 +38,7 @@ CMinx
- 1.1.9 + 1.1.10
@@ -222,7 +222,7 @@
-

© Copyright 2023, CMakePP Team.

+

© Copyright 2024, CMakePP Team.

Built with Sphinx using a diff --git a/developer/.autosummary/cminx.exceptions.html b/developer/.autosummary/cminx.exceptions.html index 69d86330..e94c824d 100644 --- a/developer/.autosummary/cminx.exceptions.html +++ b/developer/.autosummary/cminx.exceptions.html @@ -4,7 +4,7 @@ - cminx.exceptions — CMinx v1.1.9 documentation + cminx.exceptions — CMinx v1.1.10 documentation @@ -15,8 +15,8 @@ - - + + @@ -38,7 +38,7 @@ CMinx
- 1.1.9 + 1.1.10
@@ -142,7 +142,7 @@
-

© Copyright 2023, CMakePP Team.

+

© Copyright 2024, CMakePP Team.

Built with Sphinx using a diff --git a/developer/.autosummary/cminx.main.html b/developer/.autosummary/cminx.main.html index be78ee60..66b04e80 100644 --- a/developer/.autosummary/cminx.main.html +++ b/developer/.autosummary/cminx.main.html @@ -4,7 +4,7 @@ - cminx.main — CMinx v1.1.9 documentation + cminx.main — CMinx v1.1.10 documentation @@ -15,8 +15,8 @@ - - + + @@ -38,7 +38,7 @@ CMinx
- 1.1.9 + 1.1.10
Built with Sphinx using a diff --git a/developer/.autosummary/cminx.parser.CMakeLexer.html b/developer/.autosummary/cminx.parser.CMakeLexer.html index 9e2fc4e1..c122ce8e 100644 --- a/developer/.autosummary/cminx.parser.CMakeLexer.html +++ b/developer/.autosummary/cminx.parser.CMakeLexer.html @@ -4,7 +4,7 @@ - cminx.parser.CMakeLexer — CMinx v1.1.9 documentation + cminx.parser.CMakeLexer — CMinx v1.1.10 documentation @@ -15,8 +15,8 @@ - - + + @@ -38,7 +38,7 @@ CMinx
- 1.1.9 + 1.1.10
@@ -118,7 +118,7 @@
-

© Copyright 2023, CMakePP Team.

+

© Copyright 2024, CMakePP Team.

Built with Sphinx using a diff --git a/developer/.autosummary/cminx.parser.CMakeListener.html b/developer/.autosummary/cminx.parser.CMakeListener.html index ff4989a6..915319fe 100644 --- a/developer/.autosummary/cminx.parser.CMakeListener.html +++ b/developer/.autosummary/cminx.parser.CMakeListener.html @@ -4,7 +4,7 @@ - cminx.parser.CMakeListener — CMinx v1.1.9 documentation + cminx.parser.CMakeListener — CMinx v1.1.10 documentation @@ -15,8 +15,8 @@ - - + + @@ -38,7 +38,7 @@ CMinx
- 1.1.9 + 1.1.10
@@ -118,7 +118,7 @@
-

© Copyright 2023, CMakePP Team.

+

© Copyright 2024, CMakePP Team.

Built with Sphinx using a diff --git a/developer/.autosummary/cminx.parser.CMakeParser.html b/developer/.autosummary/cminx.parser.CMakeParser.html index e858dd89..d430b0f7 100644 --- a/developer/.autosummary/cminx.parser.CMakeParser.html +++ b/developer/.autosummary/cminx.parser.CMakeParser.html @@ -4,7 +4,7 @@ - cminx.parser.CMakeParser — CMinx v1.1.9 documentation + cminx.parser.CMakeParser — CMinx v1.1.10 documentation @@ -15,8 +15,8 @@ - - + + @@ -38,7 +38,7 @@ CMinx
- 1.1.9 + 1.1.10
@@ -118,7 +118,7 @@
-

© Copyright 2023, CMakePP Team.

+

© Copyright 2024, CMakePP Team.

Built with Sphinx using a diff --git a/developer/.autosummary/cminx.parser.CMakeVisitor.html b/developer/.autosummary/cminx.parser.CMakeVisitor.html index d1bda7f6..27539d24 100644 --- a/developer/.autosummary/cminx.parser.CMakeVisitor.html +++ b/developer/.autosummary/cminx.parser.CMakeVisitor.html @@ -4,7 +4,7 @@ - cminx.parser.CMakeVisitor — CMinx v1.1.9 documentation + cminx.parser.CMakeVisitor — CMinx v1.1.10 documentation @@ -15,8 +15,8 @@ - - + + @@ -38,7 +38,7 @@ CMinx
- 1.1.9 + 1.1.10
@@ -118,7 +118,7 @@
-

© Copyright 2023, CMakePP Team.

+

© Copyright 2024, CMakePP Team.

Built with Sphinx using a diff --git a/developer/.autosummary/cminx.rstwriter.html b/developer/.autosummary/cminx.rstwriter.html index 8e07abda..d9d0e675 100644 --- a/developer/.autosummary/cminx.rstwriter.html +++ b/developer/.autosummary/cminx.rstwriter.html @@ -4,7 +4,7 @@ - cminx.rstwriter — CMinx v1.1.9 documentation + cminx.rstwriter — CMinx v1.1.10 documentation @@ -15,8 +15,8 @@ - - + + @@ -38,7 +38,7 @@ CMinx
- 1.1.9 + 1.1.10
@@ -527,7 +527,7 @@
-

© Copyright 2023, CMakePP Team.

+

© Copyright 2024, CMakePP Team.

Built with Sphinx using a diff --git a/developer/api.html b/developer/api.html index 6ba03c24..52877d3d 100644 --- a/developer/api.html +++ b/developer/api.html @@ -4,7 +4,7 @@ - CMinx API — CMinx v1.1.9 documentation + CMinx API — CMinx v1.1.10 documentation @@ -15,8 +15,8 @@ - - + + @@ -38,7 +38,7 @@ CMinx
- 1.1.9 + 1.1.10
Built with Sphinx using a diff --git a/developer/ci.html b/developer/ci.html index c7607035..2353ae17 100644 --- a/developer/ci.html +++ b/developer/ci.html @@ -4,7 +4,7 @@ - CMinx’s CI — CMinx v1.1.9 documentation + CMinx’s CI — CMinx v1.1.10 documentation @@ -15,8 +15,8 @@ - - + + @@ -37,7 +37,7 @@ CMinx
- 1.1.9 + 1.1.10
@@ -122,7 +122,7 @@

Linting
-

© Copyright 2023, CMakePP Team.

+

© Copyright 2024, CMakePP Team.

Built with Sphinx using a diff --git a/developer/cmake/cminx.html b/developer/cmake/cminx.html index 2d487965..07c5d6b9 100644 --- a/developer/cmake/cminx.html +++ b/developer/cmake/cminx.html @@ -4,7 +4,7 @@ - cmake.cminx — CMinx v1.1.9 documentation + cmake.cminx — CMinx v1.1.10 documentation @@ -15,8 +15,8 @@ - - + + @@ -38,7 +38,7 @@ CMinx
- 1.1.9 + 1.1.10
@@ -135,7 +135,7 @@
-

© Copyright 2023, CMakePP Team.

+

© Copyright 2024, CMakePP Team.

Built with Sphinx using a diff --git a/developer/cmake/find_python_module.html b/developer/cmake/find_python_module.html index c4659b5f..76cd5fdf 100644 --- a/developer/cmake/find_python_module.html +++ b/developer/cmake/find_python_module.html @@ -4,7 +4,7 @@ - cmake.find_python_module — CMinx v1.1.9 documentation + cmake.find_python_module — CMinx v1.1.10 documentation @@ -15,8 +15,8 @@ - - + + @@ -38,7 +38,7 @@ CMinx
- 1.1.9 + 1.1.10
@@ -136,7 +136,7 @@
-

© Copyright 2023, CMakePP Team.

+

© Copyright 2024, CMakePP Team.

Built with Sphinx using a diff --git a/developer/cmake/get_cmaize.html b/developer/cmake/get_cmaize.html index a39f7551..f205d446 100644 --- a/developer/cmake/get_cmaize.html +++ b/developer/cmake/get_cmaize.html @@ -4,7 +4,7 @@ - cmake.get_cmaize — CMinx v1.1.9 documentation + cmake.get_cmaize — CMinx v1.1.10 documentation @@ -15,8 +15,8 @@ - - + + @@ -38,7 +38,7 @@ CMinx
- 1.1.9 + 1.1.10
@@ -128,7 +128,7 @@
-

© Copyright 2023, CMakePP Team.

+

© Copyright 2024, CMakePP Team.

Built with Sphinx using a diff --git a/developer/cmake/get_cmake_test.html b/developer/cmake/get_cmake_test.html index 48535f03..e0624fed 100644 --- a/developer/cmake/get_cmake_test.html +++ b/developer/cmake/get_cmake_test.html @@ -4,7 +4,7 @@ - cmake.get_cmake_test — CMinx v1.1.9 documentation + cmake.get_cmake_test — CMinx v1.1.10 documentation @@ -15,8 +15,8 @@ - - + + @@ -38,7 +38,7 @@ CMinx
- 1.1.9 + 1.1.10
@@ -128,7 +128,7 @@
-

© Copyright 2023, CMakePP Team.

+

© Copyright 2024, CMakePP Team.

Built with Sphinx using a diff --git a/developer/cmake/get_version_from_git.html b/developer/cmake/get_version_from_git.html index a966a17e..cc06b6a6 100644 --- a/developer/cmake/get_version_from_git.html +++ b/developer/cmake/get_version_from_git.html @@ -4,7 +4,7 @@ - cmake.get_version_from_git — CMinx v1.1.9 documentation + cmake.get_version_from_git — CMinx v1.1.10 documentation @@ -15,8 +15,8 @@ - - + + @@ -38,7 +38,7 @@ CMinx
- 1.1.9 + 1.1.10
@@ -136,7 +136,7 @@
-

© Copyright 2023, CMakePP Team.

+

© Copyright 2024, CMakePP Team.

Built with Sphinx using a diff --git a/developer/cmake/index.html b/developer/cmake/index.html index 2f3b187e..02e4baf0 100644 --- a/developer/cmake/index.html +++ b/developer/cmake/index.html @@ -4,7 +4,7 @@ - cmake — CMinx v1.1.9 documentation + cmake — CMinx v1.1.10 documentation @@ -15,8 +15,8 @@ - - + + @@ -38,7 +38,7 @@ CMinx
- 1.1.9 + 1.1.10
@@ -148,7 +148,7 @@

cmake
-

© Copyright 2023, CMakePP Team.

+

© Copyright 2024, CMakePP Team.

Built with Sphinx using a diff --git a/developer/cmake/python_virt_env.html b/developer/cmake/python_virt_env.html index 647bd50e..8a5fcbf3 100644 --- a/developer/cmake/python_virt_env.html +++ b/developer/cmake/python_virt_env.html @@ -4,7 +4,7 @@ - cmake.python_virt_env — CMinx v1.1.9 documentation + cmake.python_virt_env — CMinx v1.1.10 documentation @@ -15,8 +15,8 @@ - - + + @@ -38,7 +38,7 @@ CMinx
- 1.1.9 + 1.1.10
@@ -149,7 +149,7 @@
-

© Copyright 2023, CMakePP Team.

+

© Copyright 2024, CMakePP Team.

Built with Sphinx using a diff --git a/developer/cmake/versions.html b/developer/cmake/versions.html index 0233546e..080189b7 100644 --- a/developer/cmake/versions.html +++ b/developer/cmake/versions.html @@ -4,7 +4,7 @@ - cmake.versions — CMinx v1.1.9 documentation + cmake.versions — CMinx v1.1.10 documentation @@ -15,8 +15,8 @@ - - + + @@ -38,7 +38,7 @@ CMinx
- 1.1.9 + 1.1.10
@@ -119,7 +119,7 @@
-

© Copyright 2023, CMakePP Team.

+

© Copyright 2024, CMakePP Team.

Built with Sphinx using a diff --git a/developer/dependencies.html b/developer/dependencies.html index 246d41a1..be317675 100644 --- a/developer/dependencies.html +++ b/developer/dependencies.html @@ -4,7 +4,7 @@ - CMinx Dependencies — CMinx v1.1.9 documentation + CMinx Dependencies — CMinx v1.1.10 documentation @@ -15,8 +15,8 @@ - - + + @@ -38,7 +38,7 @@ CMinx
- 1.1.9 + 1.1.10
Built with Sphinx using a diff --git a/developer/documentation.html b/developer/documentation.html index 56fd586d..86fa66a3 100644 --- a/developer/documentation.html +++ b/developer/documentation.html @@ -4,7 +4,7 @@ - Documenting CMinx — CMinx v1.1.9 documentation + Documenting CMinx — CMinx v1.1.10 documentation @@ -15,8 +15,8 @@ - - + + @@ -38,7 +38,7 @@ CMinx
- 1.1.9 + 1.1.10
Built with Sphinx using a diff --git a/developer/index.html b/developer/index.html index 49cebbf7..bcff3d75 100644 --- a/developer/index.html +++ b/developer/index.html @@ -4,7 +4,7 @@ - Developer Documentation — CMinx v1.1.9 documentation + Developer Documentation — CMinx v1.1.10 documentation @@ -15,8 +15,8 @@ - - + + @@ -38,7 +38,7 @@ CMinx
- 1.1.9 + 1.1.10
Built with Sphinx using a diff --git a/developer/overview.html b/developer/overview.html index afc0bcdc..1f922dfc 100644 --- a/developer/overview.html +++ b/developer/overview.html @@ -4,7 +4,7 @@ - Overview of How CMinx Works — CMinx v1.1.9 documentation + Overview of How CMinx Works — CMinx v1.1.10 documentation @@ -15,8 +15,8 @@ - - + + @@ -38,7 +38,7 @@ CMinx
- 1.1.9 + 1.1.10
Built with Sphinx using a diff --git a/developer/repo_structure.html b/developer/repo_structure.html index d664b87b..abc63db0 100644 --- a/developer/repo_structure.html +++ b/developer/repo_structure.html @@ -4,7 +4,7 @@ - CMinx Repo Structure — CMinx v1.1.9 documentation + CMinx Repo Structure — CMinx v1.1.10 documentation @@ -15,8 +15,8 @@ - - + + @@ -38,7 +38,7 @@ CMinx
- 1.1.9 + 1.1.10
Built with Sphinx using a diff --git a/documenting/cmaketest.html b/documenting/cmaketest.html index 77ff71ae..e6665a29 100644 --- a/documenting/cmaketest.html +++ b/documenting/cmaketest.html @@ -4,7 +4,7 @@ - Documenting a CMakeTest Test — CMinx v1.1.9 documentation + Documenting a CMakeTest Test — CMinx v1.1.10 documentation @@ -15,8 +15,8 @@ - - + + @@ -38,7 +38,7 @@ CMinx
- 1.1.9 + 1.1.10
@@ -154,7 +154,7 @@

Documenting a CMakeTest Test -

© Copyright 2023, CMakePP Team.

+

© Copyright 2024, CMakePP Team.

Built with Sphinx using a diff --git a/documenting/ctest_add_test.html b/documenting/ctest_add_test.html index 6b422f65..d4fefe5e 100644 --- a/documenting/ctest_add_test.html +++ b/documenting/ctest_add_test.html @@ -4,7 +4,7 @@ - Documenting a CTest Test — CMinx v1.1.9 documentation + Documenting a CTest Test — CMinx v1.1.10 documentation @@ -15,8 +15,8 @@ - - + + @@ -36,7 +36,7 @@ CMinx
- 1.1.9 + 1.1.10
Built with Sphinx using a diff --git a/documenting/function.html b/documenting/function.html index fd743e0f..07b567f7 100644 --- a/documenting/function.html +++ b/documenting/function.html @@ -4,7 +4,7 @@ - Documenting a Function — CMinx v1.1.9 documentation + Documenting a Function — CMinx v1.1.10 documentation @@ -15,8 +15,8 @@ - - + + @@ -38,7 +38,7 @@ CMinx
- 1.1.9 + 1.1.10
@@ -304,7 +304,7 @@

Recommended reST Directives -

© Copyright 2023, CMakePP Team.

+

© Copyright 2024, CMakePP Team.

Built with Sphinx using a diff --git a/documenting/index.html b/documenting/index.html index d1917e2e..61fd2bf1 100644 --- a/documenting/index.html +++ b/documenting/index.html @@ -4,7 +4,7 @@ - Using CMinx to Document Your Code — CMinx v1.1.9 documentation + Using CMinx to Document Your Code — CMinx v1.1.10 documentation @@ -15,8 +15,8 @@ - - + + @@ -38,7 +38,7 @@ CMinx
- 1.1.9 + 1.1.10
@@ -126,7 +126,7 @@

Using CMinx to Document Your Code -

© Copyright 2023, CMakePP Team.

+

© Copyright 2024, CMakePP Team.

Built with Sphinx using a diff --git a/documenting/macro.html b/documenting/macro.html index 65afcefc..f582b408 100644 --- a/documenting/macro.html +++ b/documenting/macro.html @@ -4,7 +4,7 @@ - Documenting a Macro — CMinx v1.1.9 documentation + Documenting a Macro — CMinx v1.1.10 documentation @@ -15,8 +15,8 @@ - - + + @@ -38,7 +38,7 @@ CMinx
- 1.1.9 + 1.1.10
Built with Sphinx using a diff --git a/documenting/module.html b/documenting/module.html index 0bfbde25..3e0fd1fb 100644 --- a/documenting/module.html +++ b/documenting/module.html @@ -4,7 +4,7 @@ - Documenting a Module — CMinx v1.1.9 documentation + Documenting a Module — CMinx v1.1.10 documentation @@ -15,8 +15,8 @@ - - + + @@ -38,7 +38,7 @@ CMinx
- 1.1.9 + 1.1.10
@@ -216,7 +216,7 @@

Documenting a Module
-

© Copyright 2023, CMakePP Team.

+

© Copyright 2024, CMakePP Team.

Built with Sphinx using a diff --git a/documenting/types_of_comments.html b/documenting/types_of_comments.html index 4b393b28..07b0c048 100644 --- a/documenting/types_of_comments.html +++ b/documenting/types_of_comments.html @@ -4,7 +4,7 @@ - Types of Comments — CMinx v1.1.9 documentation + Types of Comments — CMinx v1.1.10 documentation @@ -15,8 +15,8 @@ - - + + @@ -38,7 +38,7 @@ CMinx
- 1.1.9 + 1.1.10
Built with Sphinx using a diff --git a/documenting/variable.html b/documenting/variable.html index 34deab28..5a970851 100644 --- a/documenting/variable.html +++ b/documenting/variable.html @@ -4,7 +4,7 @@ - Documenting a Variable — CMinx v1.1.9 documentation + Documenting a Variable — CMinx v1.1.10 documentation @@ -15,8 +15,8 @@ - - + + @@ -38,7 +38,7 @@ CMinx
- 1.1.9 + 1.1.10
@@ -171,7 +171,7 @@

Documenting a Variable
-

© Copyright 2023, CMakePP Team.

+

© Copyright 2024, CMakePP Team.

Built with Sphinx using a diff --git a/full_example.html b/full_example.html index 26d1ae12..edac20c1 100644 --- a/full_example.html +++ b/full_example.html @@ -4,7 +4,7 @@ - Example CMinx/Sphinx Workflow — CMinx v1.1.9 documentation + Example CMinx/Sphinx Workflow — CMinx v1.1.10 documentation @@ -15,8 +15,8 @@ - - + + @@ -38,7 +38,7 @@ CMinx
- 1.1.9 + 1.1.10
@@ -164,10 +164,10 @@

Step 2: Update index.rstexample/docs/source/index.rst so that the documentation Sphinx generates properly links to the API documentation. The default contents of index.rst will look something like:

-
 1.. example documentation master file, created by
- 2   sphinx-quickstart on Thu Sep  1 13:11:45 2022.
- 3   You can adapt this file completely to your liking, but it should at least
- 4   contain the root `toctree` directive.
+
 1.. example documentation master file, created by
+ 2   sphinx-quickstart on Thu Sep  1 13:11:45 2022.
+ 3   You can adapt this file completely to your liking, but it should at least
+ 4   contain the root `toctree` directive.
  5
  6Welcome to xxx's documentation!
  7===============================
@@ -293,7 +293,7 @@ 
Step 4: Run Sphinx
-    
© Copyright 2023, CMakePP Team.

+    
© Copyright 2024, CMakePP Team.

   

 
   Built with Sphinx using a
diff --git a/genindex.html b/genindex.html
index b0d36547..c4087404 100644
--- a/genindex.html
+++ b/genindex.html
@@ -3,7 +3,7 @@
 
   
   
-  Index — CMinx v1.1.9 documentation
+  Index — CMinx v1.1.10 documentation
       
       
 
@@ -14,8 +14,8 @@
   
         
         
-        
-        
+        
+        
         
     
     
@@ -35,7 +35,7 @@
             CMinx
           
               

-                1.1.9
+                1.1.10
               

 

   
@@ -751,7 +751,7 @@ 
W

   

 
   

-    
© Copyright 2023, CMakePP Team.

+    
© Copyright 2024, CMakePP Team.

   

 
   Built with Sphinx using a
diff --git a/index.html b/index.html
index f87780eb..12fa8f8e 100644
--- a/index.html
+++ b/index.html
@@ -4,7 +4,7 @@
   
 
   
-  CMinx — CMinx v1.1.9 documentation
+  CMinx — CMinx v1.1.10 documentation
       
       
 
@@ -15,8 +15,8 @@
   
         
         
-        
-        
+        
+        
         
     
     
@@ -37,7 +37,7 @@
             CMinx
           
               

-                1.1.9
+                1.1.10
               

 
 
   Built with Sphinx using a
diff --git a/installation.html b/installation.html
index 15640025..5bdb9f2a 100644
--- a/installation.html
+++ b/installation.html
@@ -4,7 +4,7 @@
   
 
   
-  Installing — CMinx v1.1.9 documentation
+  Installing — CMinx v1.1.10 documentation
       
       
 
@@ -15,8 +15,8 @@
   
         
         
-        
-        
+        
+        
         
     
     
@@ -38,7 +38,7 @@
             CMinx
           
               

-                1.1.9
+                1.1.10
               

 
 
   Built with Sphinx using a
diff --git a/objects.inv b/objects.inv
index 550010bc1f6257ec10b338da544fd688fd9066fb..402db8d7f4c9471157efd9d95839acf9578ecbab 100644
GIT binary patch
delta 13
Ucmdlhyia(7Et8?aM!R}W03j0uNdN!<

delta 12
TcmdldyjOUFEu-Z|`+80Q9jF8$

diff --git a/py-modindex.html b/py-modindex.html
index 7accaf96..6fa27ea7 100644
--- a/py-modindex.html
+++ b/py-modindex.html
@@ -3,7 +3,7 @@
 
   
   
-  Python Module Index — CMinx v1.1.9 documentation
+  Python Module Index — CMinx v1.1.10 documentation
       
       
 
@@ -14,8 +14,8 @@
   
         
         
-        
-        
+        
+        
         
     
     
@@ -38,7 +38,7 @@
             CMinx
           
               

-                1.1.9
+                1.1.10
               

 

   
@@ -200,7 +200,7 @@ 
Python Module Index

   

 
   

-    
© Copyright 2023, CMakePP Team.

+    
© Copyright 2024, CMakePP Team.

   

 
   Built with Sphinx using a
diff --git a/quickstart.html b/quickstart.html
index f0aaa03b..56677df8 100644
--- a/quickstart.html
+++ b/quickstart.html
@@ -4,7 +4,7 @@
   
 
   
-  Quickstart — CMinx v1.1.9 documentation
+  Quickstart — CMinx v1.1.10 documentation
       
       
 
@@ -15,8 +15,8 @@
   
         
         
-        
-        
+        
+        
         
     
     
@@ -38,7 +38,7 @@
             CMinx
           
               

-                1.1.9
+                1.1.10
               

 
 
   Built with Sphinx using a
diff --git a/search.html b/search.html
index 11b6749d..069a437a 100644
--- a/search.html
+++ b/search.html
@@ -3,7 +3,7 @@
 
   
   
-  Search — CMinx v1.1.9 documentation
+  Search — CMinx v1.1.10 documentation
       
       
 
@@ -15,8 +15,8 @@
   
         
         
-        
-        
+        
+        
         
     
     
@@ -38,7 +38,7 @@
             CMinx
           
               

-                1.1.9
+                1.1.10
               

 

   
@@ -102,7 +102,7 @@
   

 
   

-    
© Copyright 2023, CMakePP Team.

+    
© Copyright 2024, CMakePP Team.

   

 
   Built with Sphinx using a
diff --git a/searchindex.js b/searchindex.js
index 71bd9970..6490cc8b 100644
--- a/searchindex.js
+++ b/searchindex.js
@@ -1 +1 @@
-Search.setIndex({"docnames": ["about", "config", "developer/.autosummary/cminx.aggregator", "developer/.autosummary/cminx.config", "developer/.autosummary/cminx.document", "developer/.autosummary/cminx.document_single_file", "developer/.autosummary/cminx.documentation_types", "developer/.autosummary/cminx.documenter", "developer/.autosummary/cminx.exceptions", "developer/.autosummary/cminx.main", "developer/.autosummary/cminx.parser.CMakeLexer", "developer/.autosummary/cminx.parser.CMakeListener", "developer/.autosummary/cminx.parser.CMakeParser", "developer/.autosummary/cminx.parser.CMakeVisitor", "developer/.autosummary/cminx.rstwriter", "developer/api", "developer/ci", "developer/cmake/cminx", "developer/cmake/find_python_module", "developer/cmake/get_cmaize", "developer/cmake/get_cmake_test", "developer/cmake/get_version_from_git", "developer/cmake/index", "developer/cmake/python_virt_env", "developer/cmake/versions", "developer/dependencies", "developer/documentation", "developer/index", "developer/overview", "developer/repo_structure", "documenting/cmaketest", "documenting/ctest_add_test", "documenting/function", "documenting/index", "documenting/macro", "documenting/module", "documenting/types_of_comments", "documenting/variable", "full_example", "index", "installation", "quickstart", "usage"], "filenames": ["about.rst", "config.rst", "developer/.autosummary/cminx.aggregator.rst", "developer/.autosummary/cminx.config.rst", "developer/.autosummary/cminx.document.rst", "developer/.autosummary/cminx.document_single_file.rst", "developer/.autosummary/cminx.documentation_types.rst", "developer/.autosummary/cminx.documenter.rst", "developer/.autosummary/cminx.exceptions.rst", "developer/.autosummary/cminx.main.rst", "developer/.autosummary/cminx.parser.CMakeLexer.rst", "developer/.autosummary/cminx.parser.CMakeListener.rst", "developer/.autosummary/cminx.parser.CMakeParser.rst", "developer/.autosummary/cminx.parser.CMakeVisitor.rst", "developer/.autosummary/cminx.rstwriter.rst", "developer/api.rst", "developer/ci.rst", "developer/cmake/cminx.rst", "developer/cmake/find_python_module.rst", "developer/cmake/get_cmaize.rst", "developer/cmake/get_cmake_test.rst", "developer/cmake/get_version_from_git.rst", "developer/cmake/index.rst", "developer/cmake/python_virt_env.rst", "developer/cmake/versions.rst", "developer/dependencies.rst", "developer/documentation.rst", "developer/index.rst", "developer/overview.rst", "developer/repo_structure.rst", "documenting/cmaketest.rst", "documenting/ctest_add_test.rst", "documenting/function.rst", "documenting/index.rst", "documenting/macro.rst", "documenting/module.rst", "documenting/types_of_comments.rst", "documenting/variable.rst", "full_example.rst", "index.rst", "installation.rst", "quickstart.rst", "usage.rst"], "titles": ["CMinx Background", "Configuring CMinx", "cminx.aggregator", "cminx.config", "cminx.document", "cminx.document_single_file", "cminx.documentation_types", "cminx.documenter", "cminx.exceptions", "cminx.main", "cminx.parser.CMakeLexer", "cminx.parser.CMakeListener", "cminx.parser.CMakeParser", "cminx.parser.CMakeVisitor", "cminx.rstwriter", "CMinx API", "CMinx\u2019s CI", "cmake.cminx", "cmake.find_python_module", "cmake.get_cmaize", "cmake.get_cmake_test", "cmake.get_version_from_git", "cmake", "cmake.python_virt_env", "cmake.versions", "CMinx Dependencies", "Documenting CMinx", "Developer Documentation", "Overview of How CMinx Works", "CMinx Repo Structure", "Documenting a CMakeTest Test", "Documenting a CTest Test", "Documenting a Function", "Using CMinx to Document Your Code", "Documenting a Macro", "Documenting a Module", "Types of Comments", "Documenting a Variable", "Example CMinx/Sphinx Workflow", "CMinx", "Installing", "Quickstart", "Usage"], "terms": {"thi": [0, 1, 2, 6, 7, 8, 14, 15, 16, 18, 19, 20, 25, 26, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42], "page": [0, 16, 25, 26, 29, 38], "i": [0, 1, 2, 3, 6, 7, 8, 14, 15, 16, 18, 19, 20, 21, 25, 26, 27, 28, 29, 30, 31, 32, 34, 35, 36, 37, 38, 39, 40, 41, 42], "meant": [0, 15, 16, 25, 27], "provid": [0, 1, 6, 14, 25, 32, 40], "histor": 0, "about": [0, 25, 32, 36, 38, 39], "document": [0, 1, 2, 5, 6, 9, 14, 17, 28, 29, 36, 38, 39, 41, 42], "modul": [0, 1, 2, 6, 7, 14, 18, 23, 25, 27, 30, 31, 32, 33, 34, 36, 37, 38, 39, 41], "creation": 0, "project": [0, 15, 21, 27, 38], "A": [0, 1, 2, 6, 8, 14, 25, 32, 35, 39, 41, 42], "user": [0, 1, 6, 15, 29, 32, 34, 40], "tjwrona1992": 0, "ask": 0, "stackoverflow": 0, "how": [0, 1, 26, 27, 30, 31, 32, 35, 36, 38], "get": [0, 14, 26, 29, 32], "custom": [0, 1, 18, 41], "show": [0, 32, 35, 38, 42], "up": [0, 14, 25, 26, 32, 38, 39], "us": [0, 1, 2, 6, 7, 14, 15, 21, 23, 25, 29, 30, 31, 32, 34, 35, 36, 38, 39, 40], "help": [0, 2, 6, 25, 35, 42], "command": [0, 1, 2, 6, 15, 25, 28, 30, 31, 32, 34, 35, 37, 40, 42], "accord": [0, 36, 38, 42], "self": 0, "answer": [0, 38], "thei": [0, 1, 2, 25, 29, 32, 36, 38], "receiv": 0, "follow": [0, 1, 26, 27, 29, 32, 34, 35, 38, 40], "email": 0, "repli": 0, "from": [0, 1, 2, 5, 6, 7, 14, 17, 25, 28, 32, 34, 35, 36, 40, 41, 42], "brad": 0, "king": 0, "develop": [0, 14, 15, 16, 25, 26, 29, 39, 40], "There": [0, 35, 38], "wai": [0, 35, 38, 40], "do": [0, 1, 25, 30, 31, 32, 34, 36, 38, 39, 40], "onli": [0, 1, 6, 8, 25, 32, 35], "reason": [0, 40], "exist": [0, 1, 6, 25, 38, 39], "all": [0, 1, 2, 4, 5, 6, 7, 14, 15, 28, 32, 42], "becaus": [0, 14, 35], "prior": 0, "3": [0, 1, 6, 25, 39], "0": [0, 2, 6, 7, 14, 25, 39, 41], "wa": [0, 2, 8, 32, 42], "gener": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 14, 17, 25, 26, 28, 30, 31, 32, 34, 35, 36, 37, 38, 41, 42], "binari": 0, "itself": [0, 1, 25, 32], "peopl": [0, 32, 34], "were": [0, 25, 35], "option": [0, 2, 6, 14, 18, 32, 35, 36, 39, 42], "being": [0, 2, 14, 25, 34, 39], "avail": [0, 25], "It": [0, 1, 2, 6, 7, 16, 25, 27, 29, 35, 38, 40], "builtin": 0, "legaci": 0, "mai": [0, 8, 14, 29, 32, 34, 35, 36], "one": [0, 1, 6, 14, 25, 32, 34, 35, 38, 40, 41], "dai": 0, "go": [0, 38, 40], "awai": 0, "favor": 0, "man": 0, "html": [0, 1, 9, 32, 38], "doc": [0, 1, 6, 7, 25, 26, 29, 32, 35, 39, 42], "onlin": 0, "like": [0, 1, 14, 25, 26, 29, 32, 35, 36, 38, 41, 42], "those": [0, 1, 25, 32], "http": [0, 1, 29, 38, 40], "org": [0, 1], "v3": 0, "14": [0, 25], "publish": 0, "object": [0, 2, 3, 4, 5, 6, 7, 14, 32], "inv": 0, "support": [0, 1, 6, 25, 29, 32, 34, 37, 42], "intersphinx": 0, "www": 0, "en": [0, 29], "master": [0, 16, 38], "usag": [0, 25, 28, 35, 39], "extens": [0, 1, 25, 38, 42], "done": [0, 30, 31, 38], "request": [0, 14], "some": [0, 25, 38, 42], "so": [0, 2, 6, 8, 14, 19, 20, 32, 34, 35, 38], "haven": 0, "t": 0, "look": [0, 25, 35, 36, 38], "work": [0, 1, 3, 25, 27, 38, 41, 42], "should": [0, 1, 2, 3, 6, 7, 15, 25, 26, 29, 32, 35, 36, 38, 40], "abl": [0, 35], "own": 0, "still": [0, 32, 34, 35, 36, 38], "cross": 0, "refer": [0, 38, 42], "If": [0, 1, 2, 6, 14, 29, 32, 38, 40, 42], "you": [0, 26, 29, 30, 32, 33, 34, 38, 40, 41, 42], "we": [0, 1, 2, 23, 25, 27, 29, 32, 34, 38, 40], "d": 0, "welcom": [0, 38], "mr": 0, "add": [0, 1, 6, 14, 28, 34, 38], "describ": [0, 6, 8, 25, 32], "perhap": 0, "gitlab": 0, "kitwar": 0, "com": [0, 38, 40], "blob": 0, "dev": 0, "rst": [0, 1, 2, 3, 4, 5, 6, 7, 14, 17, 26, 28, 34, 35, 36, 39, 41, 42], "question": [0, 38], "2019": 0, "suggest": [0, 38], "write": [0, 6, 7, 14, 25, 38, 39], "via": [0, 6, 7, 23, 28, 38, 40], "note": [0, 2, 6, 8, 16, 26, 31, 32, 34, 38], "requir": [0, 6, 14, 18, 25, 29, 35, 36], "entireti": 0, "manual": [0, 6, 25, 30, 31], "e": [0, 1, 2, 6, 14, 30, 31, 32, 38, 40, 42], "tool": [0, 25], "which": [0, 1, 2, 7, 23, 25, 28, 29, 30, 31, 32, 34, 37, 38, 39, 40, 42], "extract": [0, 2, 25, 28, 36, 39], "signatur": [0, 1, 25, 32, 34], "function": [0, 1, 2, 3, 6, 14, 18, 27, 28, 30, 31, 33, 34, 35, 36, 37, 39, 40, 41, 42], "variabl": [0, 2, 6, 21, 33, 39, 40, 42], "name": [0, 1, 2, 6, 7, 9, 14, 18, 21, 23, 25, 26, 30, 31, 32, 34, 35, 36, 38, 40], "etc": [0, 1, 6, 16, 25], "ar": [0, 1, 2, 6, 14, 15, 17, 23, 25, 26, 27, 28, 29, 32, 33, 35, 36, 38, 39, 40, 42], "packag": [0, 23, 25, 40, 42], "languag": [0, 25, 26, 32, 39], "specif": [0, 14, 38], "direct": [0, 1, 6, 7, 14, 33, 35, 36, 38], "role": [0, 14, 28], "link": [0, 6, 38], "start": [0, 36, 38], "finish": [0, 38], "10": [0, 25], "21": 0, "2013": 0, "actual": [0, 6, 8, 29, 40], "pretti": 0, "bare": 0, "bone": 0, "syntax": [0, 8, 14, 42], "highlight": 0, "code": [0, 1, 8, 14, 16, 25, 26, 29, 32, 35, 36, 38, 39], "block": [0, 36, 39, 42], "macro": [0, 1, 2, 6, 19, 20, 33, 37, 39, 41], "what": [0, 1, 2, 3, 25, 29, 32, 36], "make": [0, 14, 23, 27, 29, 38], "sphinx_contrib": 0, "organ": 0, "an": [0, 1, 2, 6, 7, 8, 14, 25, 26, 28, 32, 35, 36, 37, 38, 40], "run": [0, 1, 15, 16, 25, 26, 32, 39, 40, 41, 42], "As": [0, 25, 28, 32, 35, 38], "25": 0, "2021": 0, "repo": [0, 21, 27], "ha": [0, 1, 6, 14, 25, 32, 34, 35, 36, 38, 39], "releas": 0, "inform": [0, 2, 3, 6, 28, 36], "last": [0, 1, 2, 42], "commit": 0, "1": [0, 1, 6, 9, 14, 25, 28, 32, 34, 39], "watcher": 0, "author": [0, 1, 2, 6, 7, 14], "star": 0, "fork": 0, "In": [0, 1, 25, 28, 32, 35, 38, 40], "summari": 0, "feel": [0, 38], "safe": 0, "sai": [0, 1, 6, 32, 34, 36, 41], "been": [0, 2, 25], "abandon": 0, "2018": 0, "github": [0, 16, 29, 38, 40], "bruxisma": 0, "acquir": 0, "august": 0, "20201": 0, "host": 0, "mirror": [0, 3], "intern": 0, "contain": [0, 1, 2, 3, 4, 5, 6, 7, 9, 14, 21, 26, 29, 32, 36, 38], "environ": [0, 23, 40], "autodoc": 0, "style": [0, 25, 42], "extractor": 0, "Of": [0, 25, 32], "also": [0, 1, 2, 4, 6, 7, 17, 25, 26, 32, 35, 38], "maintain": [0, 16], "pypi": [0, 40], "easi": 0, "includ": [0, 1, 2, 6, 26, 32, 34, 38, 39], "your": [0, 26, 32, 38, 39, 41, 42], "setup": [0, 29, 38], "19": 0, "8": 0, "15": 0, "9": [0, 25], "7": [0, 25], "2020": [0, 25], "seemingli": 0, "independ": 0, "target": [0, 32], "beta": 0, "state": [0, 6], "6": 0, "seem": 0, "given": [0, 2, 6, 7, 35, 40], "solo": 0, "possibl": [0, 1, 25, 38], "back": [0, 16], "burner": 0, "moment": 0, "26": 0, "envis": [0, 25], "doxygen": [0, 39], "mean": [0, 1, 32, 35, 38], "sourc": [0, 1, 3, 5, 8, 9, 16, 17, 25, 26, 29, 35, 36, 38, 39, 40], "directori": [0, 1, 2, 3, 4, 5, 7, 14, 17, 21, 26, 29, 39, 40, 41, 42], "return": [0, 7, 14, 32], "rest": [0, 1, 26, 33, 39, 41], "file": [0, 3, 4, 5, 7, 8, 14, 17, 18, 25, 26, 29, 32, 35, 36, 38, 39, 41, 42], "By": [1, 7, 16], "realiz": 1, "prefer": [1, 35, 38, 40], "vari": 1, "have": [1, 2, 14, 25, 32, 35, 38, 39, 42], "thu": [1, 32, 36, 38], "attempt": 1, "expos": 1, "mani": [1, 32, 38], "point": [1, 9, 25, 29, 32], "list": [1, 2, 3, 6, 7, 9, 14, 15, 28, 29, 32, 34, 37], "current": [1, 2, 3, 14, 41, 42], "recogn": [1, 6, 25, 32], "valu": [1, 2, 6, 14, 25, 32, 37], "can": [1, 2, 6, 14, 17, 26, 30, 31, 32, 35, 36, 38, 39, 40, 42], "set": [1, 2, 3, 4, 5, 6, 7, 14, 18, 29, 32, 35, 37, 38, 39, 42], "more": [1, 25, 32, 35, 38, 41], "order": [1, 25, 29], "overrid": [1, 35, 42], "yaml": [1, 3, 16, 25, 42], "under": [1, 25], "hood": 1, "reli": 1, "confus": [1, 3, 27], "librari": [1, 25], "locat": [1, 2, 4, 7, 8, 18, 28, 38, 41], "load": [1, 25, 42], "manag": [1, 16, 25], "directli": [1, 6, 14, 32, 35], "path": [1, 5, 14, 23, 25, 32, 35, 38, 40, 42], "place": [1, 2, 5, 16, 32, 35], "search": [1, 2, 17, 25, 38, 42], "g": [1, 14, 38], "config": [1, 25, 42], "see": [1, 25, 32, 35], "here": [1, 32, 35], "detail": [1, 25, 32, 41], "regard": 1, "For": [1, 6, 28, 29, 30, 31, 32, 34, 36, 38, 40, 42], "organiz": 1, "namespac": 1, "purpos": [1, 25, 29, 38], "partit": 1, "four": 1, "categori": [1, 36], "input": [1, 2, 3, 7, 14, 25, 35, 42], "affect": [1, 35], "part": [1, 2, 6, 25, 29, 32, 38, 40], "pars": [1, 2, 7, 25, 27, 32, 35, 36], "output": [1, 2, 3, 5, 7, 14, 17, 34, 36, 42], "result": [1, 21, 32, 35, 38, 40, 41], "pertain": [1, 16], "": [1, 2, 6, 7, 14, 18, 21, 25, 27, 29, 32, 35, 36, 38, 39, 40, 42], "messag": [1, 8, 21, 32, 34, 36, 41, 42], "control": [1, 29, 40], "format": [1, 9, 14, 16, 32, 34, 36], "One": [1, 35], "first": [1, 14, 18, 32, 35, 36, 38], "thing": 1, "doe": [1, 2, 3, 6, 14, 19, 20, 25, 32, 34, 35, 36, 38], "when": [1, 2, 6, 7, 14, 26, 29, 32, 34, 38], "initi": [1, 39], "henc": 1, "need": [1, 25, 29, 36, 38], "non": [1, 35], "hurt": 1, "anyth": [1, 32, 36], "though": [1, 35], "exampl": [1, 2, 21, 26, 28, 30, 31, 32, 34, 36, 37, 39], "api": [1, 14, 27, 38], "regardless": [1, 32, 38], "whether": [1, 2, 3, 6, 25, 34], "littl": 1, "than": [1, 25, 32, 35], "let": [1, 25], "want": [1, 25, 32, 34, 40], "undocu": 1, "case": [1, 29, 30, 31, 42], "creat": [1, 2, 6, 23, 31, 38, 39, 40], "put": [1, 16, 26, 29, 32, 38], "include_undocumented_funct": [1, 2, 3, 7, 14], "fals": [1, 2, 3, 6, 7, 14], "assum": [1, 33, 38, 41], "live": [1, 25, 26, 38, 40], "invok": 1, "other": [1, 2, 6, 14, 25, 30, 31, 32, 35], "call": [1, 2, 6, 7, 14, 28, 30, 31, 32, 35], "python": [1, 14, 16, 18, 23, 27, 32, 39], "pass": [1, 4, 5, 6, 7, 28, 32, 36, 41], "main": [1, 2, 25, 26, 29, 38], "import": [1, 38], "both": [1, 2, 42], "replac": [1, 42], "ani": [1, 2, 6, 25, 32, 35], "addit": [1, 2, 17, 25, 36, 42], "line": [1, 8, 14, 32, 34, 35, 36, 38, 41, 42], "section": [1, 2, 6, 14, 25, 30, 32], "special": [1, 6, 36], "forward": [1, 17, 32], "insid": [1, 2, 38], "system": [1, 7, 25, 38, 42], "standard": [1, 28, 42], "valid": [1, 14], "The": [1, 2, 3, 5, 6, 7, 8, 14, 16, 21, 23, 25, 26, 27, 28, 29, 32, 34, 35, 36, 37, 38, 39, 40, 41, 42], "present": [1, 14, 35, 36], "within": [1, 2, 6, 15], "long": 1, "basic": [1, 33, 34, 35, 36, 38], "version": [1, 14, 15, 21, 22, 25, 29, 32, 35, 42], "auto": 1, "true": [1, 2, 3, 6, 7, 14, 18], "include_undocumented_macro": [1, 2, 3, 7, 14], "class": [1, 2, 3, 6, 7, 14, 39], "include_undocumented_cpp_class": [1, 2, 3, 7, 14], "attribut": [1, 6], "cmakepp": [1, 6, 38, 40], "include_undocumented_cpp_attr": [1, 2, 3, 7, 14], "member": [1, 2, 6], "include_undocumented_cpp_memb": [1, 2, 3, 7, 14], "constructor": [1, 2, 6], "include_undocumented_cpp_constructor": [1, 2, 3, 7, 14], "test": [1, 2, 6, 14, 16, 26, 27, 29, 33, 39], "include_undocumented_ct_add_test": [1, 2, 3, 7, 14], "include_undocumented_ct_add_sect": [1, 2, 3, 7, 14], "include_undocumented_opt": [1, 2, 3, 7, 14], "ctest": [1, 2, 6], "vanilla": [1, 2, 6, 31], "cmake": [1, 2, 4, 5, 6, 7, 8, 9, 26, 27, 28, 29, 31, 32, 33, 34, 35, 36, 39, 41, 42], "add_test": [1, 2, 6, 31], "relat": [1, 25], "cmaketest": [1, 2, 6, 31, 33, 39], "include_undocumented_add_test": [1, 2, 3, 7, 14], "exclud": [1, 9, 25, 42], "recurs": [1, 2, 3, 7, 14, 42], "mode": [1, 14], "auto_exclude_directories_without_cmak": [1, 2, 3, 7, 14], "string": [1, 2, 4, 6, 7, 9, 14, 32, 34, 36, 37], "trigger": 1, "automat": [1, 25, 32, 34, 42], "kwarg": [1, 2, 3, 7, 14, 18, 32, 34], "encount": [1, 2], "doccom": [1, 2, 6, 7, 28, 35, 36], "definit": [1, 2, 6, 28, 30, 31], "defin": [1, 2, 6, 7, 32, 38, 41], "paramet": [1, 2, 3, 4, 5, 6, 7, 9, 14, 17, 18, 21, 23, 32, 41, 42], "modifi": [1, 28], "occur": [1, 35], "cmake_parse_argu": [1, 2, 32, 34], "bodi": [1, 35], "kwargs_doc_trigger_str": [1, 2, 3, 7, 14], "keyword": [1, 6, 33, 34], "strip": 1, "out": [1, 29, 32, 38], "match": [1, 14, 25], "regex": 1, "prefix": [1, 2, 3, 7, 14, 42], "postfix": 1, "prevent": 1, "collis": 1, "_abc_": 1, "where": [1, 8, 14, 29, 32, 38, 40], "abc": 1, "combin": [1, 7], "letter": [1, 14], "below": [1, 42], "function_parameter_name_strip_regex": [1, 2, 3, 7, 14], "_": [1, 2, 3, 7, 14], "za": 1, "z": 1, "macro_parameter_name_strip_regex": [1, 2, 3, 7, 14], "member_parameter_name_strip_regex": [1, 2, 3, 7, 14], "symlink": 1, "resolv": [1, 3, 42], "caus": 1, "infinit": 1, "parent": [1, 6], "follow_symlink": [1, 2, 3, 7, 14], "filter": [1, 25], "full": [1, 6, 23, 25, 40], "overridden": [1, 35], "exclude_filt": [1, 2, 3, 7, 14, 42], "__pycache__": 1, "stdout": 1, "instead": [1, 32, 35], "rel": [1, 3, 5, 35, 38, 42], "relative_to_config": [1, 2, 3, 7, 14], "build": [1, 7, 9, 14, 25, 29, 31, 38, 40], "highest": 1, "prioriti": 1, "properti": 1, "specifi": [1, 5, 6, 14, 18, 35, 42], "dict": [1, 3], "howto": 1, "formatt": 1, "simpl": [1, 14, 32], "asctim": 1, "levelnam": 1, "handler": [1, 4], "consol": 1, "streamhandl": 1, "chang": [1, 16, 29, 38], "level": [1, 7, 14, 27, 42], "viewabl": 1, "info": 1, "stream": [1, 7, 28], "ext": 1, "sy": [1, 9], "uncom": 1, "logfil": 1, "filehandl": 1, "debug": 1, "upon": [1, 25, 28], "execut": [1, 14, 18, 28, 29, 31, 40], "filenam": [1, 35, 42], "txt": [1, 14, 29], "append": 1, "w": 1, "eras": 1, "origin": [1, 42], "content": [1, 14, 26, 28, 29, 36, 38], "logger": 1, "propag": 1, "root": [1, 5, 38], "titl": [1, 7, 14, 35], "file_extensions_in_titl": [1, 2, 3, 7, 14], "file_extensions_in_modul": [1, 2, 3, 7, 14], "charact": [1, 6, 14, 36], "separ": [1, 32, 35, 38, 41], "between": [1, 5, 36], "module_path_separ": [1, 2, 3, 7, 14], "header": [1, 2, 3, 5, 7, 14, 36, 42], "select": [1, 3, 6, 38], "depth": [1, 32], "index": [1, 4, 14, 39], "recommend": [1, 33, 38, 40], "least": [1, 35, 38, 41], "4": [1, 25, 39], "nest": 1, "interfac": [2, 14], "parser": [2, 7, 8, 25, 28], "primari": 2, "entrypoint": [2, 7], "documentationaggreg": [2, 7], "subclass": 2, "cmakelisten": 2, "listen": [2, 7], "relev": [2, 25, 28, 40], "rule": [2, 7, 28], "documentation_typ": [2, 7], "documentationtyp": [2, 6, 7], "repres": [2, 6, 14, 28, 36], "them": [2, 28, 32, 36], "singl": [2, 5, 6, 14, 17, 35, 37], "branden": [2, 6, 7, 14], "butler": [2, 6, 7, 14], "licens": [2, 6, 7, 14, 29], "apach": [2, 6, 7, 14], "2": [2, 6, 7, 14, 25, 28, 35, 37, 39], "definitioncommand": 2, "abstractcommanddefinitiondocument": [2, 6], "none": [2, 3, 6, 7, 14, 37], "should_docu": 2, "bool": [2, 3, 6], "updat": [2, 26, 29, 32, 39], "anoth": [2, 14, 32, 38], "instanc": [2, 6, 7], "dataclass": [2, 6], "top": [2, 7, 27, 42], "stack": 2, "ignor": [2, 35], "pop": 2, "found": [2, 18, 32], "inputset": [2, 3, 7, 14], "param": [2, 3, 5, 6, 7, 14, 32, 34, 36, 41], "outputset": [2, 3, 7, 14], "log": [2, 3, 7, 14, 39], "loggingset": [2, 3, 7, 14], "logger_config": [2, 3, 7, 14], "rstset": [2, 3, 7, 14], "process": [2, 6, 7, 23, 25, 26, 28, 34, 35, 37], "docstr": [2, 28, 39], "associ": [2, 6, 14], "determin": [2, 21, 25, 29, 34], "without": [2, 35, 38], "method": [2, 6, 7, 14, 28, 40], "chosen": 2, "process_": 2, "two": [2, 14, 32, 34, 40], "argument": [2, 6, 9, 14, 33, 34, 35, 42], "ctx": 2, "type": [2, 6, 14, 28, 32, 33, 34, 37, 39], "cmakepars": [2, 7, 28], "command_invocationcontext": 2, "consum": [2, 14], "parserrulecontext": 2, "context": [2, 28, 32], "alreadi": [2, 25, 38], "definition_command_stack": 2, "construct": [2, 14], "begin": [2, 42], "end": [2, 25, 32, 36, 42], "consid": [2, 5, 25, 32, 35, 36], "cpp_class": 2, "documented_awaiting_function_def": 2, "cpp_member": 2, "await": 2, "its": [2, 6, 14, 25, 32, 35, 38], "documented_classes_stack": 2, "classdocument": [2, 6], "inner": [2, 6], "entercommand_invoc": 2, "visitor": 2, "posit": [2, 32, 42], "depend": [2, 27, 29, 39, 42], "element": [2, 14, 28, 35, 42], "cpp_end_class": 2, "enterdocumented_command": [2, 28], "documented_commandcontext": 2, "processor": 2, "parsetreewalk": [2, 7, 28], "whenev": 2, "clean": [2, 6, 28], "dispatch": 2, "process_funct": [2, 28], "antlr4": [2, 27, 28], "rais": [2, 14], "notimplementederror": 2, "process_add_test": 2, "str": [2, 3, 4, 6, 7, 8, 9, 14, 37], "ct_add_test": [2, 30], "process_cmake_parse_argu": 2, "arg": [2, 9, 14, 17], "access": 2, "has_kwarg": [2, 6], "field": [2, 6, 14, 32], "process_cpp_attr": 2, "default": [2, 3, 6, 7, 25, 32, 37, 38, 39, 42], "cpp_attr": 2, "process_cpp_class": 2, "declar": [2, 6, 35, 37], "superclass": [2, 6], "process_cpp_constructor": 2, "alia": 2, "process_cpp_memb": 2, "is_constructor": [2, 6], "reflect": 2, "methoddocument": [2, 6], "process_ct_add_sect": 2, "process_ct_add_test": 2, "process_generic_command": 2, "command_nam": 2, "invoc": [2, 6], "dedic": 2, "add_librari": 2, "process_macro": 2, "process_opt": 2, "optiondocument": [2, 6], "text": [2, 6, 14, 25, 29, 32, 35, 42], "process_set": 2, "unset": [2, 6, 37], "applic": [2, 14], "templat": [3, 25, 32], "convert": [3, 6, 32], "dictionari": 3, "config_default": [3, 25], "visit": [3, 29], "each": [3, 6, 14, 16, 28, 42], "factori": [3, 6], "config_templ": 3, "output_dir_relative_to_config": 3, "dir": [3, 17], "input_fil": 4, "perform": [4, 14, 25], "preprocess": 4, "befor": [4, 14, 29, 35], "hand": 4, "off": [4, 7, 32], "document_single_fil": 4, "over": [4, 6, 7, 28], "detect": [4, 8], "necessari": [4, 5, 14, 32], "down": [4, 5, 7, 25], "aggreg": [4, 5, 7, 27], "writer": [4, 5, 6, 7, 14], "respect": [5, 32, 42], "output_dir": [5, 38, 41], "tree": [5, 7, 14, 28], "larg": [6, 25], "assort": 6, "differ": [6, 14, 32, 34, 35, 36], "implement": [6, 32], "abstract": 6, "represent": [6, 14], "rstwriter": [6, 7, 28], "act": 6, "functiondocument": [6, 28], "macrodocument": 6, "take": [6, 32, 34], "attributedocument": 6, "parent_class": 6, "default_valu": 6, "store": [6, 14, 17], "Its": 6, "translat": [6, 35], "sphinx": [6, 27, 32, 35, 36, 39, 42], "py": [6, 25, 29], "data": [6, 14, 37], "form": [6, 14], "ad": [6, 7, 14, 27, 29, 38], "ctestdocument": 6, "hold": 6, "These": [6, 15, 25], "regular": [6, 14], "inner_class": 6, "identifi": 6, "loop": [6, 7, 28], "empti": [6, 14], "danglingdoccom": 6, "attach": [6, 35], "entiti": 6, "left": [6, 14], "unus": 6, "dangl": 6, "base": [6, 14, 35, 38], "comment": [6, 30, 31, 32, 33, 35, 37, 39, 41, 42], "serv": 6, "genericcommanddocument": 6, "fit": 6, "warn": [6, 30, 31], "unfilt": 6, "sinc": [6, 32, 34], "knowledg": [6, 39], "param_typ": 6, "is_macro": 6, "moduledocument": 6, "entir": [6, 36], "vartyp": 6, "help_text": 6, "configur": [6, 25, 32, 35, 39], "cach": 6, "sectiondocument": 6, "expect_fail": 6, "exactli": [6, 25], "testdocument": 6, "except": [6, 32, 37], "expectfail": [6, 30], "expect": [6, 8, 14, 25], "fail": [6, 35], "accept": [6, 32], "ex": [6, 14], "list_var": 6, "item1": 6, "item2": 6, "item3": 6, "str_var": 6, "hello": [6, 31], "longer": [6, 25, 32], "myvar": 6, "variabledocument": 6, "primit": 6, "well": [6, 16, 25], "impli": 6, "handl": [7, 32], "module_nam": 7, "input_stream": 7, "inputstream": 7, "read": [7, 25, 28, 38], "lexer": [7, 8, 28], "cmakelex": 7, "token": [7, 28], "our": [7, 25, 27, 29, 38, 39, 40], "parsererrorlisten": 7, "complet": [7, 14, 28, 38], "process_doc": 7, "downstream": 7, "compon": [7, 35, 36], "tokenstream": 7, "walker": [7, 28], "walk": [7, 28], "kick": 7, "cmakesyntaxexcept": 8, "msg": 8, "int": [8, 14], "denot": 8, "error": [8, 35], "usual": [8, 32, 35, 36, 38, 40], "recover": 8, "analysi": 8, "guarante": 8, "consist": 8, "halt": 8, "program": [8, 9, 25, 31, 42], "m": [9, 40], "entri": [9, 25, 29], "arrai": 9, "same": [9, 14, 25, 32, 34, 35, 39], "argv": 9, "pure": [14, 40], "restructuredtext": [14, 33, 39], "either": 14, "written": [14, 39], "invalid": 14, "structur": [14, 27, 38], "indent": 14, "toctre": [14, 38], "admonit": 14, "verifi": 14, "build_head": 14, "directivehead": 14, "head": 14, "correctli": [14, 34], "format_argu": 14, "correct": [14, 29], "maxdepth": [14, 38], "to_text": 14, "uniqu": 14, "build_heading_str": 14, "heading_str": 14, "doctest": 14, "test_lin": 14, "expected_output": 14, "build_doctest_str": 14, "popul": 14, "doctest_str": 14, "correspond": [14, 28], "field_nam": 14, "field_text": 14, "build_field_str": 14, "field_str": 14, "header_char": 14, "listtyp": 14, "bullet": 14, "enumer": 14, "build_option_str": 14, "option_str": 14, "paragraph": [14, 32], "build_text_str": 14, "text_str": 14, "rstlist": 14, "item": 14, "tupl": 14, "list_typ": 14, "build_list_str": 14, "list_str": 14, "valueerror": 14, "unknown": 14, "section_level": 14, "verif": 14, "orient": 14, "procedur": 14, "held": 14, "intermedi": 14, "until": 14, "through": [14, 32, 35, 36], "overlin": 14, "underlin": 14, "fulli": 14, "bulleted_list": 14, "vararg": 14, "desir": [14, 32], "clear": 14, "besid": 14, "topic": [14, 27], "segment": 14, "appear": [14, 25, 32, 35, 36], "interact": 14, "session": 14, "scan": 14, "ensur": [14, 16, 26, 35], "exact": 14, "evalu": 14, "enumerated_list": 14, "heading_level_char": 14, "new": [14, 19, 20, 26, 34], "subsect": 14, "simple_t": 14, "tab": 14, "column_head": 14, "tabl": [14, 38], "dimension": 14, "row": 14, "second": 14, "column": 14, "multipl": [14, 25, 32, 34], "treat": [14, 29, 36], "leftmost": 14, "must": [14, 35, 36, 41], "number": [14, 25, 32, 42], "zero": 14, "most": [14, 25, 29, 32, 38, 39], "length": 14, "inconsist": 14, "nonzero": 14, "write_to_fil": 14, "io": [14, 29], "open": [14, 25, 35], "real": 14, "filepath": 14, "local": [14, 25], "filesystem": 14, "overwritten": 14, "noth": 14, "typeerror": 14, "simplet": 14, "build_table_str": 14, "table_str": 14, "equival": [14, 28, 40], "get_ind": 14, "num": 14, "space": 14, "equal": [14, 35], "three": [14, 32, 36], "time": [14, 25, 40], "deriv": 14, "interpreted_text": 14, "interpret": [14, 18, 23, 32, 35], "almost": 14, "anywher": 14, "would": [14, 28, 38, 42], "limit": 14, "liter": 14, "find_python_modul": [15, 22], "get_cmaiz": [15, 22], "get_cmake_test": [15, 22], "get_version_from_git": [15, 22], "python_virt_env": [15, 22], "workflow": [16, 25, 29, 39, 40], "format_python": 16, "cover": 16, "proper": 16, "suit": [16, 25], "design": [16, 27, 40], "pr": 16, "push": 16, "branch": 16, "alwai": 16, "properli": [16, 38], "cminx_gen_rst": [17, 22, 38], "_cgd_dir": 17, "_cgd_output": 17, "verbatim": [17, 32], "py_": 18, "module_upp": 18, "paramat": 18, "continu": [18, 25], "_find_requir": 18, "introduc": [19, 20, 34], "scope": [19, 20, 25, 34], "gvfg_result": 21, "gvfg_git_root": 21, "git": [21, 29, 38, 40], "assign": 21, "my_project_vers": 21, "cmake_current_source_dir": 21, "my": [21, 36], "cminx": [22, 27, 30, 31, 32, 34, 35, 36, 37, 40, 41, 42], "make_python_venv": [22, 23], "python_venv_pip_instal": [22, 23], "mpv_ex": 23, "mpv_venv": 23, "wrap": 23, "virtual": [23, 40], "pvpi_venv": 23, "instal": [23, 25, 29, 38, 39], "pip": [23, 25, 29, 40], "pvpi_modul": 23, "why": [25, 27], "thrust": 25, "u": 25, "problem": 25, "script": [25, 38], "integr": [25, 38], "know": 25, "minimum": 25, "account": [25, 32, 34], "fetchcontent_makeavail": [25, 38], "infrastructur": [25, 29], "human": 25, "readabl": 25, "conceptu": 25, "exercis": 25, "ideal": [25, 32, 36, 39], "friendli": 25, "natur": 25, "particular": [25, 38, 40], "scenario": 25, "increas": 25, "robust": 25, "while": [25, 32], "cut": 25, "arguabl": [25, 38], "drawback": 25, "tend": 25, "slower": 25, "compil": 25, "analog": [25, 30, 31], "howev": [25, 32, 35], "critic": 25, "situat": 25, "moreov": 25, "anticip": 25, "o": [25, 38, 41, 42], "domin": 25, "oper": [25, 42], "fast": 25, "enough": 25, "opt": [25, 38], "futur": [25, 29], "compat": [25, 42], "__init__": 25, "incompat": [25, 42], "less": [25, 32], "antlr": 25, "de": 25, "facto": 25, "ultim": [25, 40], "abil": 25, "core": 25, "lock": 25, "turn": [25, 29, 32], "restrict": 25, "could": 25, "lift": 25, "yml": [25, 29], "check": 25, "malform": 25, "incorrect": 25, "accomplish": 25, "latest": [25, 29], "later": 25, "major": 25, "against": 25, "gitignor": [25, 29], "subdirectori": [25, 42], "thereof": 25, "suppos": 25, "confin": 25, "To": [25, 36, 38, 39], "facilit": 25, "coupl": [25, 38], "beyond": [25, 32], "simpli": [25, 35, 40], "measur": 25, "restructur": 25, "after": [25, 28, 32, 35, 36, 39], "newer": 25, "older": [25, 35], "realli": 25, "ci": [25, 27, 29], "exhaust": 25, "plugin": 25, "aid": 25, "report": 25, "wide": 25, "static": 25, "websit": [25, 38], "normal": [25, 36, 39, 40], "circumst": 25, "ever": 25, "pin": 25, "theme": 25, "featur": [25, 27, 34], "around": 25, "perus": 25, "nice": 25, "probabl": 25, "extend": 25, "achiev": 25, "similar": [25, 32], "effect": 25, "simplic": 25, "guidanc": 25, "showcas": 26, "folder": [26, 29], "along": [26, 38], "test_sampl": [26, 30, 31, 34, 35, 37], "appropri": 26, "sampl": 26, "corr_rst": 26, "literalinclud": 26, "your_exampl": 26, "unit": 26, "stai": [26, 32, 36], "date": 26, "primarili": [27, 29], "hope": [27, 29], "easier": [27, 29], "dive": 27, "recal": 27, "made": 27, "decis": 27, "did": 27, "pathspec": 27, "coverag": 27, "docutil": [27, 42], "pytest": 27, "cov": 27, "sphinx_rtd_them": 27, "overview": 27, "lint": 27, "runtim": 28, "g4": 28, "grammar": 28, "per": 28, "filestream": 28, "fed": 28, "diagrammat": 28, "summar": [28, 32], "fig": 28, "variou": [28, 29], "enter": [28, 38], "exit": [28, 42], "documented_command": 28, "subprocessor": 28, "subhandl": 28, "namedtupl": 28, "briefli": 29, "explain": 29, "interest": 29, "figur": 29, "pleas": 29, "keep": [29, 39], "displai": 29, "insensit": [29, 42], "alphabet": 29, "clone": [29, 40], "cmakelist": 29, "codecov": 29, "obligatori": 29, "softwar": [29, 39], "readm": 29, "md": 29, "setuptool": 29, "pypa": 29, "constitut": 29, "asset": 29, "again": [30, 31], "proceed": [30, 31], "ct_add_sect": 30, "test1": 30, "And": 30, "section1": 30, "endfunct": [30, 32, 35, 36, 41], "ct_test": 30, "rather": 31, "example_test": 31, "echo": 31, "working_directori": 31, "ctest_add_test": 31, "copi": 32, "strictli": 32, "speak": 32, "whatev": 32, "strongli": 32, "convent": [32, 36], "good": 32, "short": 32, "descript": [32, 36, 41], "blank": [32, 35, 41], "goe": 32, "pull": 32, "name_of_param": 32, "next": [32, 38], "nativ": 32, "aspect": 32, "veri": [32, 36, 38], "say_hi_to": [32, 36], "person": [32, 34, 36, 40], "hi": [32, 34, 36], "close": [32, 36, 39], "fanci": [32, 36], "obviou": 32, "distinguish": [32, 36], "among": 32, "boolean": 32, "float": 32, "integ": 32, "express": 32, "aforement": 32, "implicitli": 32, "sting": 32, "brief": [32, 41], "quickli": 32, "often": 32, "try": 32, "ascertain": 32, "final": [32, 38], "modern": 32, "common": [32, 39], "practic": [32, 39], "advanc": [32, 35], "advanced_say_hi_to": 32, "me": [32, 34, 36], "parse_argv": [32, 34], "_asht": [32, 34], "cat": [32, 34], "_asht_person": [32, 34], "_asht_cat": [32, 34], "although": [32, 35], "variat": [32, 34], "fact": [32, 34], "mayb": [32, 34], "even": [32, 34, 35], "notic": 32, "latter": 32, "v": 32, "render": 32, "clearli": 32, "suppli": [32, 35], "switch": 32, "toggl": 32, "subsequ": [32, 35], "encompass": 32, "nuanc": 32, "ones": 32, "map": 32, "unlik": 32, "familiar": 33, "perspect": 34, "manner": 34, "greet": 34, "macro_say_hi": 34, "endmacro": 34, "behav": 34, "biggest": 34, "wherea": 34, "basic_macro": 34, "advanced_macro_say_hi": 34, "advanced_macro": 34, "greater": 35, "5": 35, "much": 35, "few": 35, "include_guard": [35, 36], "tag": [35, 36], "accident": 35, "autogener": [35, 36], "unchang": 35, "allow": [35, 36, 38], "basic_modul": 35, "adjust": 35, "seen": 35, "advanced_module_nam": 35, "immedi": 35, "test_func": 35, "param1": 35, "abov": 35, "due": 35, "intention": 35, "obtus": 35, "heavili": 35, "advis": 35, "visual": 35, "broken": 36, "annot": 36, "everyth": 36, "els": 36, "borrow": 36, "indic": [36, 38], "am": 36, "comparison": 36, "sometim": 36, "mark": 36, "hint": 36, "therefor": 36, "unawar": 36, "akin": 36, "preprocessor": 36, "ident": 37, "preced": 37, "mylist": 37, "tutori": 38, "summarili": 38, "too": 38, "instruct": 38, "focus": 38, "free": 38, "skip": 38, "foo": [38, 40, 41], "bar": [38, 40, 41], "quickstart": [38, 39], "highli": 38, "afterward": 38, "bat": 38, "makefil": 38, "_static": 38, "_templat": 38, "fill": 38, "decid": 38, "hous": 38, "cmake_api": 38, "choos": [38, 42], "someth": 38, "sep": 38, "13": 38, "11": 38, "45": 38, "2022": 38, "adapt": 38, "xxx": 38, "caption": 38, "ref": 38, "genindex": 38, "modindex": 38, "dodgi": 38, "stuff": 38, "best": 38, "shell": [38, 42], "bash": 38, "unix": 38, "r": [38, 42], "chose": 38, "conveni": 38, "somewhat": 38, "irrelev": 38, "easili": 38, "fetchcont": 38, "fetchcontent_declar": 38, "git_repositori": 38, "cmake_current_list_dir": 38, "repositori": 38, "now": 38, "taken": 38, "establish": 39, "mechan": 39, "c": [39, 40], "solut": 39, "fix": 39, "model": 39, "With": 39, "step": 39, "background": 39, "offici": 39, "domain": 39, "channel": 40, "produc": 40, "choic": 40, "unless": 40, "termin": 40, "edit": 40, "cd": 40, "python3": 40, "venv": 40, "virt": 40, "env": 40, "bin": 40, "activ": 40, "pip3": 40, "b": 40, "build_dir": 40, "substitut": 40, "honor": 40, "cmake_install_prefix": 40, "ve": 41, "param0": 41, "th": 41, "prepend": 42, "Then": 42, "print": 42, "h": 42, "p": 42, "xdg_config_hom": 42, "linux": 42, "glob": 42}, "objects": {"cmake": [[17, 0, 0, "-", "cminx"], [18, 0, 0, "-", "find_python_module"], [19, 0, 0, "-", "get_cmaize"], [20, 0, 0, "-", "get_cmake_test"], [21, 0, 0, "-", "get_version_from_git"], [23, 0, 0, "-", "python_virt_env"], [24, 0, 0, "-", "versions"]], "cmake.cminx": [[17, 1, 1, "", "cminx_gen_rst"]], "cmake.find_python_module": [[18, 1, 1, "", "find_python_module"]], "cmake.get_cmaize": [[19, 1, 1, "", "get_cmaize"]], "cmake.get_cmake_test": [[20, 1, 1, "", "get_cmake_test"]], "cmake.get_version_from_git": [[21, 1, 1, "", "get_version_from_git"]], "cmake.python_virt_env": [[23, 1, 1, "", "make_python_venv"], [23, 1, 1, "", "python_venv_pip_install"]], "cminx": [[2, 0, 0, "-", "aggregator"], [3, 0, 0, "-", "config"], [4, 1, 1, "", "document"], [5, 1, 1, "", "document_single_file"], [6, 0, 0, "-", "documentation_types"], [7, 0, 0, "-", "documenter"], [8, 0, 0, "-", "exceptions"], [9, 1, 1, "", "main"], [14, 0, 0, "-", "rstwriter"]], "cminx.aggregator": [[2, 2, 1, "", "DefinitionCommand"], [2, 2, 1, "", "DocumentationAggregator"]], "cminx.aggregator.DefinitionCommand": [[2, 3, 1, "", "documentation"], [2, 3, 1, "", "should_document"]], "cminx.aggregator.DocumentationAggregator": [[2, 3, 1, "", "consumed"], [2, 3, 1, "", "definition_command_stack"], [2, 3, 1, "", "documented"], [2, 3, 1, "", "documented_awaiting_function_def"], [2, 3, 1, "", "documented_classes_stack"], [2, 4, 1, "", "enterCommand_invocation"], [2, 4, 1, "", "enterDocumented_command"], [2, 4, 1, "", "process_add_test"], [2, 4, 1, "", "process_cmake_parse_arguments"], [2, 4, 1, "", "process_cpp_attr"], [2, 4, 1, "", "process_cpp_class"], [2, 4, 1, "", "process_cpp_constructor"], [2, 4, 1, "", "process_cpp_member"], [2, 4, 1, "", "process_ct_add_section"], [2, 4, 1, "", "process_ct_add_test"], [2, 4, 1, "", "process_function"], [2, 4, 1, "", "process_generic_command"], [2, 4, 1, "", "process_macro"], [2, 4, 1, "", "process_option"], [2, 4, 1, "", "process_set"], [2, 3, 1, "", "settings"]], "cminx.config": [[3, 2, 1, "", "InputSettings"], [3, 2, 1, "", "LoggingSettings"], [3, 2, 1, "", "OutputSettings"], [3, 2, 1, "", "RSTSettings"], [3, 2, 1, "", "Settings"], [3, 1, 1, "", "config_template"]], "cminx.documentation_types": [[6, 2, 1, "", "AbstractCommandDefinitionDocumentation"], [6, 2, 1, "", "AttributeDocumentation"], [6, 2, 1, "", "CTestDocumentation"], [6, 2, 1, "", "ClassDocumentation"], [6, 2, 1, "", "DanglingDoccomment"], [6, 2, 1, "", "DocumentationType"], [6, 2, 1, "", "FunctionDocumentation"], [6, 2, 1, "", "GenericCommandDocumentation"], [6, 2, 1, "", "MacroDocumentation"], [6, 2, 1, "", "MethodDocumentation"], [6, 2, 1, "", "ModuleDocumentation"], [6, 2, 1, "", "OptionDocumentation"], [6, 2, 1, "", "SectionDocumentation"], [6, 2, 1, "", "TestDocumentation"], [6, 2, 1, "", "VarType"], [6, 2, 1, "", "VariableDocumentation"]], "cminx.documentation_types.AbstractCommandDefinitionDocumentation": [[6, 3, 1, "", "has_kwargs"], [6, 3, 1, "", "params"]], "cminx.documentation_types.AttributeDocumentation": [[6, 3, 1, "", "default_value"], [6, 3, 1, "", "parent_class"], [6, 4, 1, "", "process"]], "cminx.documentation_types.CTestDocumentation": [[6, 4, 1, "", "process"]], "cminx.documentation_types.ClassDocumentation": [[6, 3, 1, "", "attributes"], [6, 3, 1, "", "constructors"], [6, 3, 1, "", "inner_classes"], [6, 3, 1, "", "members"], [6, 4, 1, "", "process"], [6, 3, 1, "", "superclasses"]], "cminx.documentation_types.DanglingDoccomment": [[6, 4, 1, "", "process"]], "cminx.documentation_types.DocumentationType": [[6, 3, 1, "", "doc"], [6, 3, 1, "", "name"], [6, 4, 1, "", "process"]], "cminx.documentation_types.FunctionDocumentation": [[6, 4, 1, "", "process"]], "cminx.documentation_types.GenericCommandDocumentation": [[6, 3, 1, "", "params"], [6, 4, 1, "", "process"]], "cminx.documentation_types.MacroDocumentation": [[6, 4, 1, "", "process"]], "cminx.documentation_types.MethodDocumentation": [[6, 3, 1, "", "is_constructor"], [6, 3, 1, "", "is_macro"], [6, 3, 1, "", "param_types"], [6, 3, 1, "", "params"], [6, 3, 1, "", "parent_class"], [6, 4, 1, "", "process"]], "cminx.documentation_types.ModuleDocumentation": [[6, 4, 1, "", "process"]], "cminx.documentation_types.OptionDocumentation": [[6, 3, 1, "", "help_text"], [6, 4, 1, "", "process"]], "cminx.documentation_types.SectionDocumentation": [[6, 4, 1, "", "process"]], "cminx.documentation_types.TestDocumentation": [[6, 3, 1, "", "expect_fail"], [6, 3, 1, "", "is_macro"], [6, 3, 1, "", "params"], [6, 4, 1, "", "process"]], "cminx.documentation_types.VarType": [[6, 3, 1, "", "LIST"], [6, 3, 1, "", "STRING"], [6, 3, 1, "", "UNSET"]], "cminx.documentation_types.VariableDocumentation": [[6, 4, 1, "", "process"], [6, 3, 1, "", "type"], [6, 3, 1, "", "value"]], "cminx.documenter": [[7, 2, 1, "", "Documenter"]], "cminx.documenter.Documenter": [[7, 3, 1, "", "aggregator"], [7, 3, 1, "", "input_stream"], [7, 3, 1, "", "lexer"], [7, 3, 1, "", "module"], [7, 3, 1, "", "module_name"], [7, 3, 1, "", "parser"], [7, 4, 1, "", "process"], [7, 4, 1, "", "process_docs"], [7, 3, 1, "", "settings"], [7, 3, 1, "", "stream"], [7, 3, 1, "", "walker"], [7, 3, 1, "", "writer"]], "cminx.exceptions": [[8, 5, 1, "", "CMakeSyntaxException"]], "cminx.exceptions.CMakeSyntaxException": [[8, 3, 1, "", "line"], [8, 3, 1, "", "msg"]], "cminx.parser": [[10, 0, 0, "-", "CMakeLexer"], [11, 0, 0, "-", "CMakeListener"], [12, 0, 0, "-", "CMakeParser"], [13, 0, 0, "-", "CMakeVisitor"]], "cminx.rstwriter": [[14, 2, 1, "", "Directive"], [14, 2, 1, "", "DirectiveHeading"], [14, 2, 1, "", "DocTest"], [14, 2, 1, "", "Field"], [14, 2, 1, "", "Heading"], [14, 2, 1, "", "ListType"], [14, 2, 1, "", "Option"], [14, 2, 1, "", "Paragraph"], [14, 2, 1, "", "RSTList"], [14, 2, 1, "", "RSTWriter"], [14, 2, 1, "", "SimpleTable"], [14, 1, 1, "", "get_indents"], [14, 1, 1, "", "interpreted_text"]], "cminx.rstwriter.Directive": [[14, 4, 1, "", "build_heading"], [14, 4, 1, "", "format_arguments"], [14, 4, 1, "", "option"], [14, 4, 1, "", "to_text"]], "cminx.rstwriter.DirectiveHeading": [[14, 4, 1, "", "build_heading_string"]], "cminx.rstwriter.DocTest": [[14, 4, 1, "", "build_doctest_string"]], "cminx.rstwriter.Field": [[14, 4, 1, "", "build_field_string"]], "cminx.rstwriter.Heading": [[14, 4, 1, "", "build_heading_string"]], "cminx.rstwriter.ListType": [[14, 3, 1, "", "BULLETED"], [14, 3, 1, "", "ENUMERATED"]], "cminx.rstwriter.Option": [[14, 4, 1, "", "build_option_string"]], "cminx.rstwriter.Paragraph": [[14, 4, 1, "", "build_text_string"]], "cminx.rstwriter.RSTList": [[14, 4, 1, "", "build_list_string"]], "cminx.rstwriter.RSTWriter": [[14, 4, 1, "", "build_heading"], [14, 4, 1, "", "bulleted_list"], [14, 4, 1, "", "clear"], [14, 4, 1, "", "directive"], [14, 4, 1, "", "doctest"], [14, 4, 1, "", "enumerated_list"], [14, 4, 1, "", "field"], [14, 3, 1, "", "heading_level_chars"], [14, 4, 1, "", "section"], [14, 4, 1, "", "simple_table"], [14, 4, 1, "", "text"], [14, 4, 1, "", "to_text"], [14, 4, 1, "", "write_to_file"]], "cminx.rstwriter.SimpleTable": [[14, 4, 1, "", "build_table_string"]]}, "objtypes": {"0": "py:module", "1": "py:function", "2": "py:class", "3": "py:attribute", "4": "py:method", "5": "py:exception"}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "function", "Python function"], "2": ["py", "class", "Python class"], "3": ["py", "attribute", "Python attribute"], "4": ["py", "method", "Python method"], "5": ["py", "exception", "Python exception"]}, "titleterms": {"cminx": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 25, 26, 28, 29, 33, 38, 39], "background": 0, "The": 0, "offici": 0, "solut": 0, "sphinx": [0, 25, 38], "domain": 0, "": [0, 16], "unoffici": 0, "cmake": [0, 15, 17, 18, 19, 20, 21, 22, 23, 24, 25, 38, 40], "scikit": 0, "build": 0, "modern": 0, "marcokoch": 0, "configur": 1, "about": 1, "file": [1, 28], "write": 1, "log": 1, "option": [1, 38], "default": 1, "aggreg": [2, 28], "config": 3, "document": [4, 7, 25, 26, 27, 30, 31, 32, 33, 34, 35, 37], "document_single_fil": 5, "documentation_typ": 6, "except": 8, "main": 9, "parser": [10, 11, 12, 13], "cmakelex": 10, "cmakelisten": 11, "cmakepars": 12, "cmakevisitor": 13, "rstwriter": 14, "api": 15, "python": [15, 25, 40], "modul": [15, 35], "function": [15, 32], "ci": 16, "lint": 16, "find_python_modul": 18, "get_cmaiz": 19, "get_cmake_test": 20, "get_version_from_git": 21, "python_virt_env": 23, "version": 24, "depend": [25, 38], "antlr4": 25, "confus": 25, "pathspec": 25, "test": [25, 30, 31], "coverag": 25, "docutil": 25, "pytest": 25, "cov": 25, "sphinx_rtd_them": 25, "ad": 26, "featur": 26, "develop": 27, "tabl": [27, 39], "content": [27, 39], "overview": 28, "how": 28, "work": 28, "sourc": 28, "pars": 28, "repo": 29, "structur": 29, "top": 29, "level": 29, "cmaketest": 30, "ctest": 31, "basic": 32, "keyword": 32, "argument": 32, "recommend": 32, "rest": 32, "direct": 32, "us": 33, "your": 33, "code": 33, "macro": 34, "type": 36, "comment": 36, "variabl": 37, "exampl": 38, "workflow": 38, "step": 38, "0": 38, "1": 38, "initi": 38, "doc": 38, "directori": 38, "2": 38, "updat": 38, "index": 38, "rst": 38, "3": 38, "run": 38, "manual": 38, "modifi": 38, "conf": 38, "py": 38, "call": 38, "from": 38, "4": 38, "Of": 39, "instal": 40, "With": 40, "quickstart": 41, "usag": 42}, "envversion": {"sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx": 60}, "alltitles": {"CMinx Background": [[0, "cminx-background"]], "The Official Solution": [[0, "the-official-solution"]], "Sphinx Domain Solutions": [[0, "sphinx-domain-solutions"]], "Sphinx\u2019s (Unofficial) CMake Domain": [[0, "sphinx-s-unofficial-cmake-domain"]], "scikit-build Modern CMake Domain": [[0, "scikit-build-modern-cmake-domain"]], "MarcoKoch CMake Domain": [[0, "marcokoch-cmake-domain"]], "CMinx": [[0, "cminx"], [39, "cminx"]], "Configuring CMinx": [[1, "configuring-cminx"]], "About Configuration File": [[1, "about-configuration-file"]], "Writing a Configuration File": [[1, "writing-a-configuration-file"]], "Logging Options": [[1, "logging-options"]], "Default Configuration File": [[1, "default-configuration-file"]], "cminx.aggregator": [[2, "module-cminx.aggregator"]], "cminx.config": [[3, "module-cminx.config"]], "cminx.document": [[4, "cminx-document"]], "cminx.document_single_file": [[5, "cminx-document-single-file"]], "cminx.documentation_types": [[6, "module-cminx.documentation_types"]], "cminx.documenter": [[7, "module-cminx.documenter"]], "cminx.exceptions": [[8, "module-cminx.exceptions"]], "cminx.main": [[9, "cminx-main"]], "cminx.parser.CMakeLexer": [[10, "module-cminx.parser.CMakeLexer"]], "cminx.parser.CMakeListener": [[11, "module-cminx.parser.CMakeListener"]], "cminx.parser.CMakeParser": [[12, "module-cminx.parser.CMakeParser"]], "cminx.parser.CMakeVisitor": [[13, "module-cminx.parser.CMakeVisitor"]], "cminx.rstwriter": [[14, "module-cminx.rstwriter"]], "CMinx API": [[15, "cminx-api"]], "Python Modules": [[15, "python-modules"]], "Functions": [[15, "functions"]], "CMake Modules": [[15, "cmake-modules"]], "CMinx\u2019s CI": [[16, "cminx-s-ci"]], "Linting": [[16, "linting"]], "cmake.cminx": [[17, "module-cmake.cminx"]], "cmake.find_python_module": [[18, "module-cmake.find_python_module"]], "cmake.get_cmaize": [[19, "module-cmake.get_cmaize"]], "cmake.get_cmake_test": [[20, "module-cmake.get_cmake_test"]], "cmake.get_version_from_git": [[21, "module-cmake.get_version_from_git"]], "cmake": [[22, "cmake"]], "cmake.python_virt_env": [[23, "module-cmake.python_virt_env"]], "cmake.versions": [[24, "module-cmake.versions"]], "CMinx Dependencies": [[25, "cminx-dependencies"]], "CMake": [[25, "cmake"]], "Python": [[25, "python"]], "Antlr4": [[25, "antlr4"]], "Confuse": [[25, "confuse"]], "PathSpec": [[25, "pathspec"]], "CMinx Testing Dependencies": [[25, "cminx-testing-dependencies"]], "coverage": [[25, "coverage"]], "docutils": [[25, "docutils"]], "pytest": [[25, "pytest"]], "pytest-cov": [[25, "pytest-cov"]], "CMinx Documentation Dependencies": [[25, "cminx-documentation-dependencies"]], "sphinx": [[25, "sphinx"]], "sphinx_rtd_theme": [[25, "sphinx-rtd-theme"]], "Documenting CMinx": [[26, "documenting-cminx"]], "Adding a Feature": [[26, "adding-a-feature"]], "Developer Documentation": [[27, "developer-documentation"]], "Table of Contents": [[27, "table-of-contents"]], "Overview of How CMinx Works": [[28, "overview-of-how-cminx-works"]], "Source File Parsing": [[28, null]], "Parsing": [[28, "parsing"]], "Aggregation": [[28, "aggregation"]], "CMinx Repo Structure": [[29, "cminx-repo-structure"]], "Top Level": [[29, "top-level"]], "Documenting a CMakeTest Test": [[30, "documenting-a-cmaketest-test"]], "Documenting a CTest Test": [[31, "documenting-a-ctest-test"]], "Documenting a Function": [[32, "documenting-a-function"]], "Basic Function Documentation": [[32, "basic-function-documentation"]], "Documenting Keyword Arguments": [[32, "documenting-keyword-arguments"]], "Recommended reST Directives": [[32, "recommended-rest-directives"]], "Using CMinx to Document Your Code": [[33, "using-cminx-to-document-your-code"]], "Documenting a Macro": [[34, "documenting-a-macro"]], "Documenting a Module": [[35, "documenting-a-module"]], "Types of Comments": [[36, "types-of-comments"]], "Documenting a Variable": [[37, "documenting-a-variable"]], "Example CMinx/Sphinx Workflow": [[38, "example-cminx-sphinx-workflow"]], "Step 0: Dependencies": [[38, "step-0-dependencies"]], "Step 1: Initialize the docs/ Directory": [[38, "step-1-initialize-the-docs-directory"]], "Step 2: Update index.rst": [[38, "step-2-update-index-rst"]], "Step 3: Run CMinx": [[38, "step-3-run-cminx"]], "Option 1: Manually run CMinx": [[38, "option-1-manually-run-cminx"]], "Option 2: Modify conf.py": [[38, "option-2-modify-conf-py"]], "Option 3: Call CMinx from CMake": [[38, "option-3-call-cminx-from-cmake"]], "Step 4: Run Sphinx": [[38, "step-4-run-sphinx"]], "Table Of Contents": [[39, "table-of-contents"]], "Installing": [[40, "installing"]], "Pythonically": [[40, "pythonically"]], "With CMake": [[40, "with-cmake"]], "Quickstart": [[41, "quickstart"]], "Usage": [[42, "usage"]]}, "indexentries": {"definitioncommand (class in cminx.aggregator)": [[2, "cminx.aggregator.DefinitionCommand"]], "documentationaggregator (class in cminx.aggregator)": [[2, "cminx.aggregator.DocumentationAggregator"]], "cminx.aggregator": [[2, "module-cminx.aggregator"]], "consumed (cminx.aggregator.documentationaggregator attribute)": [[2, "cminx.aggregator.DocumentationAggregator.consumed"]], "definition_command_stack (cminx.aggregator.documentationaggregator attribute)": [[2, "cminx.aggregator.DocumentationAggregator.definition_command_stack"]], "documentation (cminx.aggregator.definitioncommand attribute)": [[2, "cminx.aggregator.DefinitionCommand.documentation"]], "documented (cminx.aggregator.documentationaggregator attribute)": [[2, "cminx.aggregator.DocumentationAggregator.documented"]], "documented_awaiting_function_def (cminx.aggregator.documentationaggregator attribute)": [[2, "cminx.aggregator.DocumentationAggregator.documented_awaiting_function_def"]], "documented_classes_stack (cminx.aggregator.documentationaggregator attribute)": [[2, "cminx.aggregator.DocumentationAggregator.documented_classes_stack"]], "entercommand_invocation() (cminx.aggregator.documentationaggregator method)": [[2, "cminx.aggregator.DocumentationAggregator.enterCommand_invocation"]], "enterdocumented_command() (cminx.aggregator.documentationaggregator method)": [[2, "cminx.aggregator.DocumentationAggregator.enterDocumented_command"]], "module": [[2, "module-cminx.aggregator"], [3, "module-cminx.config"], [6, "module-cminx.documentation_types"], [7, "module-cminx.documenter"], [8, "module-cminx.exceptions"], [10, "module-cminx.parser.CMakeLexer"], [11, "module-cminx.parser.CMakeListener"], [12, "module-cminx.parser.CMakeParser"], [13, "module-cminx.parser.CMakeVisitor"], [14, "module-cminx.rstwriter"], [17, "module-cmake.cminx"], [18, "module-cmake.find_python_module"], [19, "module-cmake.get_cmaize"], [20, "module-cmake.get_cmake_test"], [21, "module-cmake.get_version_from_git"], [23, "module-cmake.python_virt_env"], [24, "module-cmake.versions"]], "process_add_test() (cminx.aggregator.documentationaggregator method)": [[2, "cminx.aggregator.DocumentationAggregator.process_add_test"]], "process_cmake_parse_arguments() (cminx.aggregator.documentationaggregator method)": [[2, "cminx.aggregator.DocumentationAggregator.process_cmake_parse_arguments"]], "process_cpp_attr() (cminx.aggregator.documentationaggregator method)": [[2, "cminx.aggregator.DocumentationAggregator.process_cpp_attr"]], "process_cpp_class() (cminx.aggregator.documentationaggregator method)": [[2, "cminx.aggregator.DocumentationAggregator.process_cpp_class"]], "process_cpp_constructor() (cminx.aggregator.documentationaggregator method)": [[2, "cminx.aggregator.DocumentationAggregator.process_cpp_constructor"]], "process_cpp_member() (cminx.aggregator.documentationaggregator method)": [[2, "cminx.aggregator.DocumentationAggregator.process_cpp_member"]], "process_ct_add_section() (cminx.aggregator.documentationaggregator method)": [[2, "cminx.aggregator.DocumentationAggregator.process_ct_add_section"]], "process_ct_add_test() (cminx.aggregator.documentationaggregator method)": [[2, "cminx.aggregator.DocumentationAggregator.process_ct_add_test"]], "process_function() (cminx.aggregator.documentationaggregator method)": [[2, "cminx.aggregator.DocumentationAggregator.process_function"]], "process_generic_command() (cminx.aggregator.documentationaggregator method)": [[2, "cminx.aggregator.DocumentationAggregator.process_generic_command"]], "process_macro() (cminx.aggregator.documentationaggregator method)": [[2, "cminx.aggregator.DocumentationAggregator.process_macro"]], "process_option() (cminx.aggregator.documentationaggregator method)": [[2, "cminx.aggregator.DocumentationAggregator.process_option"]], "process_set() (cminx.aggregator.documentationaggregator method)": [[2, "cminx.aggregator.DocumentationAggregator.process_set"]], "settings (cminx.aggregator.documentationaggregator attribute)": [[2, "cminx.aggregator.DocumentationAggregator.settings"]], "should_document (cminx.aggregator.definitioncommand attribute)": [[2, "cminx.aggregator.DefinitionCommand.should_document"]], "inputsettings (class in cminx.config)": [[3, "cminx.config.InputSettings"]], "loggingsettings (class in cminx.config)": [[3, "cminx.config.LoggingSettings"]], "outputsettings (class in cminx.config)": [[3, "cminx.config.OutputSettings"]], "rstsettings (class in cminx.config)": [[3, "cminx.config.RSTSettings"]], "settings (class in cminx.config)": [[3, "cminx.config.Settings"]], "cminx.config": [[3, "module-cminx.config"]], "config_template() (in module cminx.config)": [[3, "cminx.config.config_template"]], "document() (in module cminx)": [[4, "cminx.document"]], "document_single_file() (in module cminx)": [[5, "cminx.document_single_file"]], "abstractcommanddefinitiondocumentation (class in cminx.documentation_types)": [[6, "cminx.documentation_types.AbstractCommandDefinitionDocumentation"]], "attributedocumentation (class in cminx.documentation_types)": [[6, "cminx.documentation_types.AttributeDocumentation"]], "ctestdocumentation (class in cminx.documentation_types)": [[6, "cminx.documentation_types.CTestDocumentation"]], "classdocumentation (class in cminx.documentation_types)": [[6, "cminx.documentation_types.ClassDocumentation"]], "danglingdoccomment (class in cminx.documentation_types)": [[6, "cminx.documentation_types.DanglingDoccomment"]], "documentationtype (class in cminx.documentation_types)": [[6, "cminx.documentation_types.DocumentationType"]], "functiondocumentation (class in cminx.documentation_types)": [[6, "cminx.documentation_types.FunctionDocumentation"]], "genericcommanddocumentation (class in cminx.documentation_types)": [[6, "cminx.documentation_types.GenericCommandDocumentation"]], "list (cminx.documentation_types.vartype attribute)": [[6, "cminx.documentation_types.VarType.LIST"]], "macrodocumentation (class in cminx.documentation_types)": [[6, "cminx.documentation_types.MacroDocumentation"]], "methoddocumentation (class in cminx.documentation_types)": [[6, "cminx.documentation_types.MethodDocumentation"]], "moduledocumentation (class in cminx.documentation_types)": [[6, "cminx.documentation_types.ModuleDocumentation"]], "optiondocumentation (class in cminx.documentation_types)": [[6, "cminx.documentation_types.OptionDocumentation"]], "string (cminx.documentation_types.vartype attribute)": [[6, "cminx.documentation_types.VarType.STRING"]], "sectiondocumentation (class in cminx.documentation_types)": [[6, "cminx.documentation_types.SectionDocumentation"]], "testdocumentation (class in cminx.documentation_types)": [[6, "cminx.documentation_types.TestDocumentation"]], "unset (cminx.documentation_types.vartype attribute)": [[6, "cminx.documentation_types.VarType.UNSET"]], "vartype (class in cminx.documentation_types)": [[6, "cminx.documentation_types.VarType"]], "variabledocumentation (class in cminx.documentation_types)": [[6, "cminx.documentation_types.VariableDocumentation"]], "attributes (cminx.documentation_types.classdocumentation attribute)": [[6, "cminx.documentation_types.ClassDocumentation.attributes"]], "cminx.documentation_types": [[6, "module-cminx.documentation_types"]], "constructors (cminx.documentation_types.classdocumentation attribute)": [[6, "cminx.documentation_types.ClassDocumentation.constructors"]], "default_value (cminx.documentation_types.attributedocumentation attribute)": [[6, "cminx.documentation_types.AttributeDocumentation.default_value"]], "doc (cminx.documentation_types.documentationtype attribute)": [[6, "cminx.documentation_types.DocumentationType.doc"]], "expect_fail (cminx.documentation_types.testdocumentation attribute)": [[6, "cminx.documentation_types.TestDocumentation.expect_fail"]], "has_kwargs (cminx.documentation_types.abstractcommanddefinitiondocumentation attribute)": [[6, "cminx.documentation_types.AbstractCommandDefinitionDocumentation.has_kwargs"]], "help_text (cminx.documentation_types.optiondocumentation attribute)": [[6, "cminx.documentation_types.OptionDocumentation.help_text"]], "inner_classes (cminx.documentation_types.classdocumentation attribute)": [[6, "cminx.documentation_types.ClassDocumentation.inner_classes"]], "is_constructor (cminx.documentation_types.methoddocumentation attribute)": [[6, "cminx.documentation_types.MethodDocumentation.is_constructor"]], "is_macro (cminx.documentation_types.methoddocumentation attribute)": [[6, "cminx.documentation_types.MethodDocumentation.is_macro"]], "is_macro (cminx.documentation_types.testdocumentation attribute)": [[6, "cminx.documentation_types.TestDocumentation.is_macro"]], "members (cminx.documentation_types.classdocumentation attribute)": [[6, "cminx.documentation_types.ClassDocumentation.members"]], "name (cminx.documentation_types.documentationtype attribute)": [[6, "cminx.documentation_types.DocumentationType.name"]], "param_types (cminx.documentation_types.methoddocumentation attribute)": [[6, "cminx.documentation_types.MethodDocumentation.param_types"]], "params (cminx.documentation_types.abstractcommanddefinitiondocumentation attribute)": [[6, "cminx.documentation_types.AbstractCommandDefinitionDocumentation.params"]], "params (cminx.documentation_types.genericcommanddocumentation attribute)": [[6, "cminx.documentation_types.GenericCommandDocumentation.params"]], "params (cminx.documentation_types.methoddocumentation attribute)": [[6, "cminx.documentation_types.MethodDocumentation.params"]], "params (cminx.documentation_types.testdocumentation attribute)": [[6, "cminx.documentation_types.TestDocumentation.params"]], "parent_class (cminx.documentation_types.attributedocumentation attribute)": [[6, "cminx.documentation_types.AttributeDocumentation.parent_class"]], "parent_class (cminx.documentation_types.methoddocumentation attribute)": [[6, "cminx.documentation_types.MethodDocumentation.parent_class"]], "process() (cminx.documentation_types.attributedocumentation method)": [[6, "cminx.documentation_types.AttributeDocumentation.process"]], "process() (cminx.documentation_types.ctestdocumentation method)": [[6, "cminx.documentation_types.CTestDocumentation.process"]], "process() (cminx.documentation_types.classdocumentation method)": [[6, "cminx.documentation_types.ClassDocumentation.process"]], "process() (cminx.documentation_types.danglingdoccomment method)": [[6, "cminx.documentation_types.DanglingDoccomment.process"]], "process() (cminx.documentation_types.documentationtype method)": [[6, "cminx.documentation_types.DocumentationType.process"]], "process() (cminx.documentation_types.functiondocumentation method)": [[6, "cminx.documentation_types.FunctionDocumentation.process"]], "process() (cminx.documentation_types.genericcommanddocumentation method)": [[6, "cminx.documentation_types.GenericCommandDocumentation.process"]], "process() (cminx.documentation_types.macrodocumentation method)": [[6, "cminx.documentation_types.MacroDocumentation.process"]], "process() (cminx.documentation_types.methoddocumentation method)": [[6, "cminx.documentation_types.MethodDocumentation.process"]], "process() (cminx.documentation_types.moduledocumentation method)": [[6, "cminx.documentation_types.ModuleDocumentation.process"]], "process() (cminx.documentation_types.optiondocumentation method)": [[6, "cminx.documentation_types.OptionDocumentation.process"]], "process() (cminx.documentation_types.sectiondocumentation method)": [[6, "cminx.documentation_types.SectionDocumentation.process"]], "process() (cminx.documentation_types.testdocumentation method)": [[6, "cminx.documentation_types.TestDocumentation.process"]], "process() (cminx.documentation_types.variabledocumentation method)": [[6, "cminx.documentation_types.VariableDocumentation.process"]], "superclasses (cminx.documentation_types.classdocumentation attribute)": [[6, "cminx.documentation_types.ClassDocumentation.superclasses"]], "type (cminx.documentation_types.variabledocumentation attribute)": [[6, "cminx.documentation_types.VariableDocumentation.type"]], "value (cminx.documentation_types.variabledocumentation attribute)": [[6, "cminx.documentation_types.VariableDocumentation.value"]], "documenter (class in cminx.documenter)": [[7, "cminx.documenter.Documenter"]], "aggregator (cminx.documenter.documenter attribute)": [[7, "cminx.documenter.Documenter.aggregator"]], "cminx.documenter": [[7, "module-cminx.documenter"]], "input_stream (cminx.documenter.documenter attribute)": [[7, "cminx.documenter.Documenter.input_stream"]], "lexer (cminx.documenter.documenter attribute)": [[7, "cminx.documenter.Documenter.lexer"]], "module (cminx.documenter.documenter attribute)": [[7, "cminx.documenter.Documenter.module"]], "module_name (cminx.documenter.documenter attribute)": [[7, "cminx.documenter.Documenter.module_name"]], "parser (cminx.documenter.documenter attribute)": [[7, "cminx.documenter.Documenter.parser"]], "process() (cminx.documenter.documenter method)": [[7, "cminx.documenter.Documenter.process"]], "process_docs() (cminx.documenter.documenter method)": [[7, "cminx.documenter.Documenter.process_docs"]], "settings (cminx.documenter.documenter attribute)": [[7, "cminx.documenter.Documenter.settings"]], "stream (cminx.documenter.documenter attribute)": [[7, "cminx.documenter.Documenter.stream"]], "walker (cminx.documenter.documenter attribute)": [[7, "cminx.documenter.Documenter.walker"]], "writer (cminx.documenter.documenter attribute)": [[7, "cminx.documenter.Documenter.writer"]], "cmakesyntaxexception": [[8, "cminx.exceptions.CMakeSyntaxException"]], "cminx.exceptions": [[8, "module-cminx.exceptions"]], "line (cminx.exceptions.cmakesyntaxexception attribute)": [[8, "cminx.exceptions.CMakeSyntaxException.line"]], "msg (cminx.exceptions.cmakesyntaxexception attribute)": [[8, "cminx.exceptions.CMakeSyntaxException.msg"]], "main() (in module cminx)": [[9, "cminx.main"]], "cminx.parser.cmakelexer": [[10, "module-cminx.parser.CMakeLexer"]], "cminx.parser.cmakelistener": [[11, "module-cminx.parser.CMakeListener"]], "cminx.parser.cmakeparser": [[12, "module-cminx.parser.CMakeParser"]], "cminx.parser.cmakevisitor": [[13, "module-cminx.parser.CMakeVisitor"]], "bulleted (cminx.rstwriter.listtype attribute)": [[14, "cminx.rstwriter.ListType.BULLETED"]], "directive (class in cminx.rstwriter)": [[14, "cminx.rstwriter.Directive"]], "directiveheading (class in cminx.rstwriter)": [[14, "cminx.rstwriter.DirectiveHeading"]], "doctest (class in cminx.rstwriter)": [[14, "cminx.rstwriter.DocTest"]], "enumerated (cminx.rstwriter.listtype attribute)": [[14, "cminx.rstwriter.ListType.ENUMERATED"]], "field (class in cminx.rstwriter)": [[14, "cminx.rstwriter.Field"]], "heading (class in cminx.rstwriter)": [[14, "cminx.rstwriter.Heading"]], "listtype (class in cminx.rstwriter)": [[14, "cminx.rstwriter.ListType"]], "option (class in cminx.rstwriter)": [[14, "cminx.rstwriter.Option"]], "paragraph (class in cminx.rstwriter)": [[14, "cminx.rstwriter.Paragraph"]], "rstlist (class in cminx.rstwriter)": [[14, "cminx.rstwriter.RSTList"]], "rstwriter (class in cminx.rstwriter)": [[14, "cminx.rstwriter.RSTWriter"]], "simpletable (class in cminx.rstwriter)": [[14, "cminx.rstwriter.SimpleTable"]], "build_doctest_string() (cminx.rstwriter.doctest method)": [[14, "cminx.rstwriter.DocTest.build_doctest_string"]], "build_field_string() (cminx.rstwriter.field method)": [[14, "cminx.rstwriter.Field.build_field_string"]], "build_heading() (cminx.rstwriter.directive method)": [[14, "cminx.rstwriter.Directive.build_heading"]], "build_heading() (cminx.rstwriter.rstwriter method)": [[14, "cminx.rstwriter.RSTWriter.build_heading"]], "build_heading_string() (cminx.rstwriter.directiveheading method)": [[14, "cminx.rstwriter.DirectiveHeading.build_heading_string"]], "build_heading_string() (cminx.rstwriter.heading method)": [[14, "cminx.rstwriter.Heading.build_heading_string"]], "build_list_string() (cminx.rstwriter.rstlist method)": [[14, "cminx.rstwriter.RSTList.build_list_string"]], "build_option_string() (cminx.rstwriter.option method)": [[14, "cminx.rstwriter.Option.build_option_string"]], "build_table_string() (cminx.rstwriter.simpletable method)": [[14, "cminx.rstwriter.SimpleTable.build_table_string"]], "build_text_string() (cminx.rstwriter.paragraph method)": [[14, "cminx.rstwriter.Paragraph.build_text_string"]], "bulleted_list() (cminx.rstwriter.rstwriter method)": [[14, "cminx.rstwriter.RSTWriter.bulleted_list"]], "clear() (cminx.rstwriter.rstwriter method)": [[14, "cminx.rstwriter.RSTWriter.clear"]], "cminx.rstwriter": [[14, "module-cminx.rstwriter"]], "directive() (cminx.rstwriter.rstwriter method)": [[14, "cminx.rstwriter.RSTWriter.directive"]], "doctest() (cminx.rstwriter.rstwriter method)": [[14, "cminx.rstwriter.RSTWriter.doctest"]], "enumerated_list() (cminx.rstwriter.rstwriter method)": [[14, "cminx.rstwriter.RSTWriter.enumerated_list"]], "field() (cminx.rstwriter.rstwriter method)": [[14, "cminx.rstwriter.RSTWriter.field"]], "format_arguments() (cminx.rstwriter.directive method)": [[14, "cminx.rstwriter.Directive.format_arguments"]], "get_indents() (in module cminx.rstwriter)": [[14, "cminx.rstwriter.get_indents"]], "heading_level_chars (cminx.rstwriter.rstwriter attribute)": [[14, "cminx.rstwriter.RSTWriter.heading_level_chars"]], "interpreted_text() (in module cminx.rstwriter)": [[14, "cminx.rstwriter.interpreted_text"]], "option() (cminx.rstwriter.directive method)": [[14, "cminx.rstwriter.Directive.option"]], "section() (cminx.rstwriter.rstwriter method)": [[14, "cminx.rstwriter.RSTWriter.section"]], "simple_table() (cminx.rstwriter.rstwriter method)": [[14, "cminx.rstwriter.RSTWriter.simple_table"]], "text() (cminx.rstwriter.rstwriter method)": [[14, "cminx.rstwriter.RSTWriter.text"]], "to_text() (cminx.rstwriter.directive method)": [[14, "cminx.rstwriter.Directive.to_text"]], "to_text() (cminx.rstwriter.rstwriter method)": [[14, "cminx.rstwriter.RSTWriter.to_text"]], "write_to_file() (cminx.rstwriter.rstwriter method)": [[14, "cminx.rstwriter.RSTWriter.write_to_file"]], "cmake.cminx": [[17, "module-cmake.cminx"]], "cminx_gen_rst() (in module cmake.cminx)": [[17, "cmake.cminx.cminx_gen_rst"]], "cmake.find_python_module": [[18, "module-cmake.find_python_module"]], "find_python_module() (in module cmake.find_python_module)": [[18, "cmake.find_python_module.find_python_module"]], "cmake.get_cmaize": [[19, "module-cmake.get_cmaize"]], "get_cmaize() (in module cmake.get_cmaize)": [[19, "cmake.get_cmaize.get_cmaize"]], "cmake.get_cmake_test": [[20, "module-cmake.get_cmake_test"]], "get_cmake_test() (in module cmake.get_cmake_test)": [[20, "cmake.get_cmake_test.get_cmake_test"]], "cmake.get_version_from_git": [[21, "module-cmake.get_version_from_git"]], "get_version_from_git() (in module cmake.get_version_from_git)": [[21, "cmake.get_version_from_git.get_version_from_git"]], "cmake.python_virt_env": [[23, "module-cmake.python_virt_env"]], "make_python_venv() (in module cmake.python_virt_env)": [[23, "cmake.python_virt_env.make_python_venv"]], "python_venv_pip_install() (in module cmake.python_virt_env)": [[23, "cmake.python_virt_env.python_venv_pip_install"]], "cmake.versions": [[24, "module-cmake.versions"]]}})
\ No newline at end of file
+Search.setIndex({"alltitles": {"About Configuration File": [[1, "about-configuration-file"]], "Adding a Feature": [[26, "adding-a-feature"]], "Aggregation": [[28, "aggregation"]], "Antlr4": [[25, "antlr4"]], "Basic Function Documentation": [[32, "basic-function-documentation"]], "CMake": [[25, "cmake"]], "CMake Modules": [[15, "cmake-modules"]], "CMinx": [[0, "cminx"], [39, null]], "CMinx API": [[15, null]], "CMinx Background": [[0, null]], "CMinx Dependencies": [[25, null]], "CMinx Documentation Dependencies": [[25, "cminx-documentation-dependencies"]], "CMinx Repo Structure": [[29, null]], "CMinx Testing Dependencies": [[25, "cminx-testing-dependencies"]], "CMinx\u2019s CI": [[16, null]], "Configuring CMinx": [[1, null]], "Confuse": [[25, "confuse"]], "Default Configuration File": [[1, "default-configuration-file"]], "Developer Documentation": [[27, null]], "Documenting CMinx": [[26, null]], "Documenting Keyword Arguments": [[32, "documenting-keyword-arguments"]], "Documenting a CMakeTest Test": [[30, null]], "Documenting a CTest Test": [[31, null]], "Documenting a Function": [[32, null]], "Documenting a Macro": [[34, null]], "Documenting a Module": [[35, null]], "Documenting a Variable": [[37, null]], "Example CMinx/Sphinx Workflow": [[38, null]], "Functions": [[15, "functions"]], "Installing": [[40, null]], "Linting": [[16, "linting"]], "Logging Options": [[1, "logging-options"]], "MarcoKoch CMake Domain": [[0, "marcokoch-cmake-domain"]], "Option 1: Manually run CMinx": [[38, "option-1-manually-run-cminx"]], "Option 2: Modify conf.py": [[38, "option-2-modify-conf-py"]], "Option 3: Call CMinx from CMake": [[38, "option-3-call-cminx-from-cmake"]], "Overview of How CMinx Works": [[28, null]], "Parsing": [[28, "parsing"]], "PathSpec": [[25, "pathspec"]], "Python": [[25, "python"]], "Python Modules": [[15, "python-modules"]], "Pythonically": [[40, "pythonically"]], "Quickstart": [[41, null]], "Recommended reST Directives": [[32, "recommended-rest-directives"]], "Source File Parsing": [[28, null]], "Sphinx Domain Solutions": [[0, "sphinx-domain-solutions"]], "Sphinx\u2019s (Unofficial) CMake Domain": [[0, "sphinx-s-unofficial-cmake-domain"]], "Step 0: Dependencies": [[38, "step-0-dependencies"]], "Step 1: Initialize the docs/ Directory": [[38, "step-1-initialize-the-docs-directory"]], "Step 2: Update index.rst": [[38, "step-2-update-index-rst"]], "Step 3: Run CMinx": [[38, "step-3-run-cminx"]], "Step 4: Run Sphinx": [[38, "step-4-run-sphinx"]], "Table Of Contents": [[39, "table-of-contents"]], "Table of Contents": [[27, "table-of-contents"]], "The Official Solution": [[0, "the-official-solution"]], "Top Level": [[29, "top-level"]], "Types of Comments": [[36, null]], "Usage": [[42, null]], "Using CMinx to Document Your Code": [[33, null]], "With CMake": [[40, "with-cmake"]], "Writing a Configuration File": [[1, "writing-a-configuration-file"]], "cmake": [[22, null]], "cmake.cminx": [[17, null]], "cmake.find_python_module": [[18, null]], "cmake.get_cmaize": [[19, null]], "cmake.get_cmake_test": [[20, null]], "cmake.get_version_from_git": [[21, null]], "cmake.python_virt_env": [[23, null]], "cmake.versions": [[24, null]], "cminx.aggregator": [[2, null]], "cminx.config": [[3, null]], "cminx.document": [[4, null]], "cminx.document_single_file": [[5, null]], "cminx.documentation_types": [[6, null]], "cminx.documenter": [[7, null]], "cminx.exceptions": [[8, null]], "cminx.main": [[9, null]], "cminx.parser.CMakeLexer": [[10, null]], "cminx.parser.CMakeListener": [[11, null]], "cminx.parser.CMakeParser": [[12, null]], "cminx.parser.CMakeVisitor": [[13, null]], "cminx.rstwriter": [[14, null]], "coverage": [[25, "coverage"]], "docutils": [[25, "docutils"]], "pytest": [[25, "pytest"]], "pytest-cov": [[25, "pytest-cov"]], "scikit-build Modern CMake Domain": [[0, "scikit-build-modern-cmake-domain"]], "sphinx": [[25, "sphinx"]], "sphinx_rtd_theme": [[25, "sphinx-rtd-theme"]]}, "docnames": ["about", "config", "developer/.autosummary/cminx.aggregator", "developer/.autosummary/cminx.config", "developer/.autosummary/cminx.document", "developer/.autosummary/cminx.document_single_file", "developer/.autosummary/cminx.documentation_types", "developer/.autosummary/cminx.documenter", "developer/.autosummary/cminx.exceptions", "developer/.autosummary/cminx.main", "developer/.autosummary/cminx.parser.CMakeLexer", "developer/.autosummary/cminx.parser.CMakeListener", "developer/.autosummary/cminx.parser.CMakeParser", "developer/.autosummary/cminx.parser.CMakeVisitor", "developer/.autosummary/cminx.rstwriter", "developer/api", "developer/ci", "developer/cmake/cminx", "developer/cmake/find_python_module", "developer/cmake/get_cmaize", "developer/cmake/get_cmake_test", "developer/cmake/get_version_from_git", "developer/cmake/index", "developer/cmake/python_virt_env", "developer/cmake/versions", "developer/dependencies", "developer/documentation", "developer/index", "developer/overview", "developer/repo_structure", "documenting/cmaketest", "documenting/ctest_add_test", "documenting/function", "documenting/index", "documenting/macro", "documenting/module", "documenting/types_of_comments", "documenting/variable", "full_example", "index", "installation", "quickstart", "usage"], "envversion": {"sphinx": 62, "sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2}, "filenames": ["about.rst", "config.rst", "developer/.autosummary/cminx.aggregator.rst", "developer/.autosummary/cminx.config.rst", "developer/.autosummary/cminx.document.rst", "developer/.autosummary/cminx.document_single_file.rst", "developer/.autosummary/cminx.documentation_types.rst", "developer/.autosummary/cminx.documenter.rst", "developer/.autosummary/cminx.exceptions.rst", "developer/.autosummary/cminx.main.rst", "developer/.autosummary/cminx.parser.CMakeLexer.rst", "developer/.autosummary/cminx.parser.CMakeListener.rst", "developer/.autosummary/cminx.parser.CMakeParser.rst", "developer/.autosummary/cminx.parser.CMakeVisitor.rst", "developer/.autosummary/cminx.rstwriter.rst", "developer/api.rst", "developer/ci.rst", "developer/cmake/cminx.rst", "developer/cmake/find_python_module.rst", "developer/cmake/get_cmaize.rst", "developer/cmake/get_cmake_test.rst", "developer/cmake/get_version_from_git.rst", "developer/cmake/index.rst", "developer/cmake/python_virt_env.rst", "developer/cmake/versions.rst", "developer/dependencies.rst", "developer/documentation.rst", "developer/index.rst", "developer/overview.rst", "developer/repo_structure.rst", "documenting/cmaketest.rst", "documenting/ctest_add_test.rst", "documenting/function.rst", "documenting/index.rst", "documenting/macro.rst", "documenting/module.rst", "documenting/types_of_comments.rst", "documenting/variable.rst", "full_example.rst", "index.rst", "installation.rst", "quickstart.rst", "usage.rst"], "indexentries": {"abstractcommanddefinitiondocumentation (class in cminx.documentation_types)": [[6, "cminx.documentation_types.AbstractCommandDefinitionDocumentation", false]], "aggregator (cminx.documenter.documenter attribute)": [[7, "cminx.documenter.Documenter.aggregator", false]], "attributedocumentation (class in cminx.documentation_types)": [[6, "cminx.documentation_types.AttributeDocumentation", false]], "attributes (cminx.documentation_types.classdocumentation attribute)": [[6, "cminx.documentation_types.ClassDocumentation.attributes", false]], "build_doctest_string() (cminx.rstwriter.doctest method)": [[14, "cminx.rstwriter.DocTest.build_doctest_string", false]], "build_field_string() (cminx.rstwriter.field method)": [[14, "cminx.rstwriter.Field.build_field_string", false]], "build_heading() (cminx.rstwriter.directive method)": [[14, "cminx.rstwriter.Directive.build_heading", false]], "build_heading() (cminx.rstwriter.rstwriter method)": [[14, "cminx.rstwriter.RSTWriter.build_heading", false]], "build_heading_string() (cminx.rstwriter.directiveheading method)": [[14, "cminx.rstwriter.DirectiveHeading.build_heading_string", false]], "build_heading_string() (cminx.rstwriter.heading method)": [[14, "cminx.rstwriter.Heading.build_heading_string", false]], "build_list_string() (cminx.rstwriter.rstlist method)": [[14, "cminx.rstwriter.RSTList.build_list_string", false]], "build_option_string() (cminx.rstwriter.option method)": [[14, "cminx.rstwriter.Option.build_option_string", false]], "build_table_string() (cminx.rstwriter.simpletable method)": [[14, "cminx.rstwriter.SimpleTable.build_table_string", false]], "build_text_string() (cminx.rstwriter.paragraph method)": [[14, "cminx.rstwriter.Paragraph.build_text_string", false]], "bulleted (cminx.rstwriter.listtype attribute)": [[14, "cminx.rstwriter.ListType.BULLETED", false]], "bulleted_list() (cminx.rstwriter.rstwriter method)": [[14, "cminx.rstwriter.RSTWriter.bulleted_list", false]], "classdocumentation (class in cminx.documentation_types)": [[6, "cminx.documentation_types.ClassDocumentation", false]], "clear() (cminx.rstwriter.rstwriter method)": [[14, "cminx.rstwriter.RSTWriter.clear", false]], "cmake.cminx": [[17, "module-cmake.cminx", false]], "cmake.find_python_module": [[18, "module-cmake.find_python_module", false]], "cmake.get_cmaize": [[19, "module-cmake.get_cmaize", false]], "cmake.get_cmake_test": [[20, "module-cmake.get_cmake_test", false]], "cmake.get_version_from_git": [[21, "module-cmake.get_version_from_git", false]], "cmake.python_virt_env": [[23, "module-cmake.python_virt_env", false]], "cmake.versions": [[24, "module-cmake.versions", false]], "cmakesyntaxexception": [[8, "cminx.exceptions.CMakeSyntaxException", false]], "cminx.aggregator": [[2, "module-cminx.aggregator", false]], "cminx.config": [[3, "module-cminx.config", false]], "cminx.documentation_types": [[6, "module-cminx.documentation_types", false]], "cminx.documenter": [[7, "module-cminx.documenter", false]], "cminx.exceptions": [[8, "module-cminx.exceptions", false]], "cminx.parser.cmakelexer": [[10, "module-cminx.parser.CMakeLexer", false]], "cminx.parser.cmakelistener": [[11, "module-cminx.parser.CMakeListener", false]], "cminx.parser.cmakeparser": [[12, "module-cminx.parser.CMakeParser", false]], "cminx.parser.cmakevisitor": [[13, "module-cminx.parser.CMakeVisitor", false]], "cminx.rstwriter": [[14, "module-cminx.rstwriter", false]], "cminx_gen_rst() (in module cmake.cminx)": [[17, "cmake.cminx.cminx_gen_rst", false]], "config_template() (in module cminx.config)": [[3, "cminx.config.config_template", false]], "constructors (cminx.documentation_types.classdocumentation attribute)": [[6, "cminx.documentation_types.ClassDocumentation.constructors", false]], "consumed (cminx.aggregator.documentationaggregator attribute)": [[2, "cminx.aggregator.DocumentationAggregator.consumed", false]], "ctestdocumentation (class in cminx.documentation_types)": [[6, "cminx.documentation_types.CTestDocumentation", false]], "danglingdoccomment (class in cminx.documentation_types)": [[6, "cminx.documentation_types.DanglingDoccomment", false]], "default_value (cminx.documentation_types.attributedocumentation attribute)": [[6, "cminx.documentation_types.AttributeDocumentation.default_value", false]], "definition_command_stack (cminx.aggregator.documentationaggregator attribute)": [[2, "cminx.aggregator.DocumentationAggregator.definition_command_stack", false]], "definitioncommand (class in cminx.aggregator)": [[2, "cminx.aggregator.DefinitionCommand", false]], "directive (class in cminx.rstwriter)": [[14, "cminx.rstwriter.Directive", false]], "directive() (cminx.rstwriter.rstwriter method)": [[14, "cminx.rstwriter.RSTWriter.directive", false]], "directiveheading (class in cminx.rstwriter)": [[14, "cminx.rstwriter.DirectiveHeading", false]], "doc (cminx.documentation_types.documentationtype attribute)": [[6, "cminx.documentation_types.DocumentationType.doc", false]], "doctest (class in cminx.rstwriter)": [[14, "cminx.rstwriter.DocTest", false]], "doctest() (cminx.rstwriter.rstwriter method)": [[14, "cminx.rstwriter.RSTWriter.doctest", false]], "document() (in module cminx)": [[4, "cminx.document", false]], "document_single_file() (in module cminx)": [[5, "cminx.document_single_file", false]], "documentation (cminx.aggregator.definitioncommand attribute)": [[2, "cminx.aggregator.DefinitionCommand.documentation", false]], "documentationaggregator (class in cminx.aggregator)": [[2, "cminx.aggregator.DocumentationAggregator", false]], "documentationtype (class in cminx.documentation_types)": [[6, "cminx.documentation_types.DocumentationType", false]], "documented (cminx.aggregator.documentationaggregator attribute)": [[2, "cminx.aggregator.DocumentationAggregator.documented", false]], "documented_awaiting_function_def (cminx.aggregator.documentationaggregator attribute)": [[2, "cminx.aggregator.DocumentationAggregator.documented_awaiting_function_def", false]], "documented_classes_stack (cminx.aggregator.documentationaggregator attribute)": [[2, "cminx.aggregator.DocumentationAggregator.documented_classes_stack", false]], "documenter (class in cminx.documenter)": [[7, "cminx.documenter.Documenter", false]], "entercommand_invocation() (cminx.aggregator.documentationaggregator method)": [[2, "cminx.aggregator.DocumentationAggregator.enterCommand_invocation", false]], "enterdocumented_command() (cminx.aggregator.documentationaggregator method)": [[2, "cminx.aggregator.DocumentationAggregator.enterDocumented_command", false]], "enumerated (cminx.rstwriter.listtype attribute)": [[14, "cminx.rstwriter.ListType.ENUMERATED", false]], "enumerated_list() (cminx.rstwriter.rstwriter method)": [[14, "cminx.rstwriter.RSTWriter.enumerated_list", false]], "expect_fail (cminx.documentation_types.testdocumentation attribute)": [[6, "cminx.documentation_types.TestDocumentation.expect_fail", false]], "field (class in cminx.rstwriter)": [[14, "cminx.rstwriter.Field", false]], "field() (cminx.rstwriter.rstwriter method)": [[14, "cminx.rstwriter.RSTWriter.field", false]], "find_python_module() (in module cmake.find_python_module)": [[18, "cmake.find_python_module.find_python_module", false]], "format_arguments() (cminx.rstwriter.directive method)": [[14, "cminx.rstwriter.Directive.format_arguments", false]], "functiondocumentation (class in cminx.documentation_types)": [[6, "cminx.documentation_types.FunctionDocumentation", false]], "genericcommanddocumentation (class in cminx.documentation_types)": [[6, "cminx.documentation_types.GenericCommandDocumentation", false]], "get_cmaize() (in module cmake.get_cmaize)": [[19, "cmake.get_cmaize.get_cmaize", false]], "get_cmake_test() (in module cmake.get_cmake_test)": [[20, "cmake.get_cmake_test.get_cmake_test", false]], "get_indents() (in module cminx.rstwriter)": [[14, "cminx.rstwriter.get_indents", false]], "get_version_from_git() (in module cmake.get_version_from_git)": [[21, "cmake.get_version_from_git.get_version_from_git", false]], "has_kwargs (cminx.documentation_types.abstractcommanddefinitiondocumentation attribute)": [[6, "cminx.documentation_types.AbstractCommandDefinitionDocumentation.has_kwargs", false]], "heading (class in cminx.rstwriter)": [[14, "cminx.rstwriter.Heading", false]], "heading_level_chars (cminx.rstwriter.rstwriter attribute)": [[14, "cminx.rstwriter.RSTWriter.heading_level_chars", false]], "help_text (cminx.documentation_types.optiondocumentation attribute)": [[6, "cminx.documentation_types.OptionDocumentation.help_text", false]], "inner_classes (cminx.documentation_types.classdocumentation attribute)": [[6, "cminx.documentation_types.ClassDocumentation.inner_classes", false]], "input_stream (cminx.documenter.documenter attribute)": [[7, "cminx.documenter.Documenter.input_stream", false]], "inputsettings (class in cminx.config)": [[3, "cminx.config.InputSettings", false]], "interpreted_text() (in module cminx.rstwriter)": [[14, "cminx.rstwriter.interpreted_text", false]], "is_constructor (cminx.documentation_types.methoddocumentation attribute)": [[6, "cminx.documentation_types.MethodDocumentation.is_constructor", false]], "is_macro (cminx.documentation_types.methoddocumentation attribute)": [[6, "cminx.documentation_types.MethodDocumentation.is_macro", false]], "is_macro (cminx.documentation_types.testdocumentation attribute)": [[6, "cminx.documentation_types.TestDocumentation.is_macro", false]], "lexer (cminx.documenter.documenter attribute)": [[7, "cminx.documenter.Documenter.lexer", false]], "line (cminx.exceptions.cmakesyntaxexception attribute)": [[8, "cminx.exceptions.CMakeSyntaxException.line", false]], "list (cminx.documentation_types.vartype attribute)": [[6, "cminx.documentation_types.VarType.LIST", false]], "listtype (class in cminx.rstwriter)": [[14, "cminx.rstwriter.ListType", false]], "loggingsettings (class in cminx.config)": [[3, "cminx.config.LoggingSettings", false]], "macrodocumentation (class in cminx.documentation_types)": [[6, "cminx.documentation_types.MacroDocumentation", false]], "main() (in module cminx)": [[9, "cminx.main", false]], "make_python_venv() (in module cmake.python_virt_env)": [[23, "cmake.python_virt_env.make_python_venv", false]], "members (cminx.documentation_types.classdocumentation attribute)": [[6, "cminx.documentation_types.ClassDocumentation.members", false]], "methoddocumentation (class in cminx.documentation_types)": [[6, "cminx.documentation_types.MethodDocumentation", false]], "module": [[2, "module-cminx.aggregator", false], [3, "module-cminx.config", false], [6, "module-cminx.documentation_types", false], [7, "module-cminx.documenter", false], [8, "module-cminx.exceptions", false], [10, "module-cminx.parser.CMakeLexer", false], [11, "module-cminx.parser.CMakeListener", false], [12, "module-cminx.parser.CMakeParser", false], [13, "module-cminx.parser.CMakeVisitor", false], [14, "module-cminx.rstwriter", false], [17, "module-cmake.cminx", false], [18, "module-cmake.find_python_module", false], [19, "module-cmake.get_cmaize", false], [20, "module-cmake.get_cmake_test", false], [21, "module-cmake.get_version_from_git", false], [23, "module-cmake.python_virt_env", false], [24, "module-cmake.versions", false]], "module (cminx.documenter.documenter attribute)": [[7, "cminx.documenter.Documenter.module", false]], "module_name (cminx.documenter.documenter attribute)": [[7, "cminx.documenter.Documenter.module_name", false]], "moduledocumentation (class in cminx.documentation_types)": [[6, "cminx.documentation_types.ModuleDocumentation", false]], "msg (cminx.exceptions.cmakesyntaxexception attribute)": [[8, "cminx.exceptions.CMakeSyntaxException.msg", false]], "name (cminx.documentation_types.documentationtype attribute)": [[6, "cminx.documentation_types.DocumentationType.name", false]], "option (class in cminx.rstwriter)": [[14, "cminx.rstwriter.Option", false]], "option() (cminx.rstwriter.directive method)": [[14, "cminx.rstwriter.Directive.option", false]], "optiondocumentation (class in cminx.documentation_types)": [[6, "cminx.documentation_types.OptionDocumentation", false]], "outputsettings (class in cminx.config)": [[3, "cminx.config.OutputSettings", false]], "paragraph (class in cminx.rstwriter)": [[14, "cminx.rstwriter.Paragraph", false]], "param_types (cminx.documentation_types.methoddocumentation attribute)": [[6, "cminx.documentation_types.MethodDocumentation.param_types", false]], "params (cminx.documentation_types.abstractcommanddefinitiondocumentation attribute)": [[6, "cminx.documentation_types.AbstractCommandDefinitionDocumentation.params", false]], "params (cminx.documentation_types.genericcommanddocumentation attribute)": [[6, "cminx.documentation_types.GenericCommandDocumentation.params", false]], "params (cminx.documentation_types.methoddocumentation attribute)": [[6, "cminx.documentation_types.MethodDocumentation.params", false]], "params (cminx.documentation_types.testdocumentation attribute)": [[6, "cminx.documentation_types.TestDocumentation.params", false]], "parent_class (cminx.documentation_types.attributedocumentation attribute)": [[6, "cminx.documentation_types.AttributeDocumentation.parent_class", false]], "parent_class (cminx.documentation_types.methoddocumentation attribute)": [[6, "cminx.documentation_types.MethodDocumentation.parent_class", false]], "parser (cminx.documenter.documenter attribute)": [[7, "cminx.documenter.Documenter.parser", false]], "process() (cminx.documentation_types.attributedocumentation method)": [[6, "cminx.documentation_types.AttributeDocumentation.process", false]], "process() (cminx.documentation_types.classdocumentation method)": [[6, "cminx.documentation_types.ClassDocumentation.process", false]], "process() (cminx.documentation_types.ctestdocumentation method)": [[6, "cminx.documentation_types.CTestDocumentation.process", false]], "process() (cminx.documentation_types.danglingdoccomment method)": [[6, "cminx.documentation_types.DanglingDoccomment.process", false]], "process() (cminx.documentation_types.documentationtype method)": [[6, "cminx.documentation_types.DocumentationType.process", false]], "process() (cminx.documentation_types.functiondocumentation method)": [[6, "cminx.documentation_types.FunctionDocumentation.process", false]], "process() (cminx.documentation_types.genericcommanddocumentation method)": [[6, "cminx.documentation_types.GenericCommandDocumentation.process", false]], "process() (cminx.documentation_types.macrodocumentation method)": [[6, "cminx.documentation_types.MacroDocumentation.process", false]], "process() (cminx.documentation_types.methoddocumentation method)": [[6, "cminx.documentation_types.MethodDocumentation.process", false]], "process() (cminx.documentation_types.moduledocumentation method)": [[6, "cminx.documentation_types.ModuleDocumentation.process", false]], "process() (cminx.documentation_types.optiondocumentation method)": [[6, "cminx.documentation_types.OptionDocumentation.process", false]], "process() (cminx.documentation_types.sectiondocumentation method)": [[6, "cminx.documentation_types.SectionDocumentation.process", false]], "process() (cminx.documentation_types.testdocumentation method)": [[6, "cminx.documentation_types.TestDocumentation.process", false]], "process() (cminx.documentation_types.variabledocumentation method)": [[6, "cminx.documentation_types.VariableDocumentation.process", false]], "process() (cminx.documenter.documenter method)": [[7, "cminx.documenter.Documenter.process", false]], "process_add_test() (cminx.aggregator.documentationaggregator method)": [[2, "cminx.aggregator.DocumentationAggregator.process_add_test", false]], "process_cmake_parse_arguments() (cminx.aggregator.documentationaggregator method)": [[2, "cminx.aggregator.DocumentationAggregator.process_cmake_parse_arguments", false]], "process_cpp_attr() (cminx.aggregator.documentationaggregator method)": [[2, "cminx.aggregator.DocumentationAggregator.process_cpp_attr", false]], "process_cpp_class() (cminx.aggregator.documentationaggregator method)": [[2, "cminx.aggregator.DocumentationAggregator.process_cpp_class", false]], "process_cpp_constructor() (cminx.aggregator.documentationaggregator method)": [[2, "cminx.aggregator.DocumentationAggregator.process_cpp_constructor", false]], "process_cpp_member() (cminx.aggregator.documentationaggregator method)": [[2, "cminx.aggregator.DocumentationAggregator.process_cpp_member", false]], "process_ct_add_section() (cminx.aggregator.documentationaggregator method)": [[2, "cminx.aggregator.DocumentationAggregator.process_ct_add_section", false]], "process_ct_add_test() (cminx.aggregator.documentationaggregator method)": [[2, "cminx.aggregator.DocumentationAggregator.process_ct_add_test", false]], "process_docs() (cminx.documenter.documenter method)": [[7, "cminx.documenter.Documenter.process_docs", false]], "process_function() (cminx.aggregator.documentationaggregator method)": [[2, "cminx.aggregator.DocumentationAggregator.process_function", false]], "process_generic_command() (cminx.aggregator.documentationaggregator method)": [[2, "cminx.aggregator.DocumentationAggregator.process_generic_command", false]], "process_macro() (cminx.aggregator.documentationaggregator method)": [[2, "cminx.aggregator.DocumentationAggregator.process_macro", false]], "process_option() (cminx.aggregator.documentationaggregator method)": [[2, "cminx.aggregator.DocumentationAggregator.process_option", false]], "process_set() (cminx.aggregator.documentationaggregator method)": [[2, "cminx.aggregator.DocumentationAggregator.process_set", false]], "python_venv_pip_install() (in module cmake.python_virt_env)": [[23, "cmake.python_virt_env.python_venv_pip_install", false]], "rstlist (class in cminx.rstwriter)": [[14, "cminx.rstwriter.RSTList", false]], "rstsettings (class in cminx.config)": [[3, "cminx.config.RSTSettings", false]], "rstwriter (class in cminx.rstwriter)": [[14, "cminx.rstwriter.RSTWriter", false]], "section() (cminx.rstwriter.rstwriter method)": [[14, "cminx.rstwriter.RSTWriter.section", false]], "sectiondocumentation (class in cminx.documentation_types)": [[6, "cminx.documentation_types.SectionDocumentation", false]], "settings (class in cminx.config)": [[3, "cminx.config.Settings", false]], "settings (cminx.aggregator.documentationaggregator attribute)": [[2, "cminx.aggregator.DocumentationAggregator.settings", false]], "settings (cminx.documenter.documenter attribute)": [[7, "cminx.documenter.Documenter.settings", false]], "should_document (cminx.aggregator.definitioncommand attribute)": [[2, "cminx.aggregator.DefinitionCommand.should_document", false]], "simple_table() (cminx.rstwriter.rstwriter method)": [[14, "cminx.rstwriter.RSTWriter.simple_table", false]], "simpletable (class in cminx.rstwriter)": [[14, "cminx.rstwriter.SimpleTable", false]], "stream (cminx.documenter.documenter attribute)": [[7, "cminx.documenter.Documenter.stream", false]], "string (cminx.documentation_types.vartype attribute)": [[6, "cminx.documentation_types.VarType.STRING", false]], "superclasses (cminx.documentation_types.classdocumentation attribute)": [[6, "cminx.documentation_types.ClassDocumentation.superclasses", false]], "testdocumentation (class in cminx.documentation_types)": [[6, "cminx.documentation_types.TestDocumentation", false]], "text() (cminx.rstwriter.rstwriter method)": [[14, "cminx.rstwriter.RSTWriter.text", false]], "to_text() (cminx.rstwriter.directive method)": [[14, "cminx.rstwriter.Directive.to_text", false]], "to_text() (cminx.rstwriter.rstwriter method)": [[14, "cminx.rstwriter.RSTWriter.to_text", false]], "type (cminx.documentation_types.variabledocumentation attribute)": [[6, "cminx.documentation_types.VariableDocumentation.type", false]], "unset (cminx.documentation_types.vartype attribute)": [[6, "cminx.documentation_types.VarType.UNSET", false]], "value (cminx.documentation_types.variabledocumentation attribute)": [[6, "cminx.documentation_types.VariableDocumentation.value", false]], "variabledocumentation (class in cminx.documentation_types)": [[6, "cminx.documentation_types.VariableDocumentation", false]], "vartype (class in cminx.documentation_types)": [[6, "cminx.documentation_types.VarType", false]], "walker (cminx.documenter.documenter attribute)": [[7, "cminx.documenter.Documenter.walker", false]], "write_to_file() (cminx.rstwriter.rstwriter method)": [[14, "cminx.rstwriter.RSTWriter.write_to_file", false]], "writer (cminx.documenter.documenter attribute)": [[7, "cminx.documenter.Documenter.writer", false]]}, "objects": {"cmake": [[17, 0, 0, "-", "cminx"], [18, 0, 0, "-", "find_python_module"], [19, 0, 0, "-", "get_cmaize"], [20, 0, 0, "-", "get_cmake_test"], [21, 0, 0, "-", "get_version_from_git"], [23, 0, 0, "-", "python_virt_env"], [24, 0, 0, "-", "versions"]], "cmake.cminx": [[17, 1, 1, "", "cminx_gen_rst"]], "cmake.find_python_module": [[18, 1, 1, "", "find_python_module"]], "cmake.get_cmaize": [[19, 1, 1, "", "get_cmaize"]], "cmake.get_cmake_test": [[20, 1, 1, "", "get_cmake_test"]], "cmake.get_version_from_git": [[21, 1, 1, "", "get_version_from_git"]], "cmake.python_virt_env": [[23, 1, 1, "", "make_python_venv"], [23, 1, 1, "", "python_venv_pip_install"]], "cminx": [[2, 0, 0, "-", "aggregator"], [3, 0, 0, "-", "config"], [4, 1, 1, "", "document"], [5, 1, 1, "", "document_single_file"], [6, 0, 0, "-", "documentation_types"], [7, 0, 0, "-", "documenter"], [8, 0, 0, "-", "exceptions"], [9, 1, 1, "", "main"], [14, 0, 0, "-", "rstwriter"]], "cminx.aggregator": [[2, 2, 1, "", "DefinitionCommand"], [2, 2, 1, "", "DocumentationAggregator"]], "cminx.aggregator.DefinitionCommand": [[2, 3, 1, "", "documentation"], [2, 3, 1, "", "should_document"]], "cminx.aggregator.DocumentationAggregator": [[2, 3, 1, "", "consumed"], [2, 3, 1, "", "definition_command_stack"], [2, 3, 1, "", "documented"], [2, 3, 1, "", "documented_awaiting_function_def"], [2, 3, 1, "", "documented_classes_stack"], [2, 4, 1, "", "enterCommand_invocation"], [2, 4, 1, "", "enterDocumented_command"], [2, 4, 1, "", "process_add_test"], [2, 4, 1, "", "process_cmake_parse_arguments"], [2, 4, 1, "", "process_cpp_attr"], [2, 4, 1, "", "process_cpp_class"], [2, 4, 1, "", "process_cpp_constructor"], [2, 4, 1, "", "process_cpp_member"], [2, 4, 1, "", "process_ct_add_section"], [2, 4, 1, "", "process_ct_add_test"], [2, 4, 1, "", "process_function"], [2, 4, 1, "", "process_generic_command"], [2, 4, 1, "", "process_macro"], [2, 4, 1, "", "process_option"], [2, 4, 1, "", "process_set"], [2, 3, 1, "", "settings"]], "cminx.config": [[3, 2, 1, "", "InputSettings"], [3, 2, 1, "", "LoggingSettings"], [3, 2, 1, "", "OutputSettings"], [3, 2, 1, "", "RSTSettings"], [3, 2, 1, "", "Settings"], [3, 1, 1, "", "config_template"]], "cminx.documentation_types": [[6, 2, 1, "", "AbstractCommandDefinitionDocumentation"], [6, 2, 1, "", "AttributeDocumentation"], [6, 2, 1, "", "CTestDocumentation"], [6, 2, 1, "", "ClassDocumentation"], [6, 2, 1, "", "DanglingDoccomment"], [6, 2, 1, "", "DocumentationType"], [6, 2, 1, "", "FunctionDocumentation"], [6, 2, 1, "", "GenericCommandDocumentation"], [6, 2, 1, "", "MacroDocumentation"], [6, 2, 1, "", "MethodDocumentation"], [6, 2, 1, "", "ModuleDocumentation"], [6, 2, 1, "", "OptionDocumentation"], [6, 2, 1, "", "SectionDocumentation"], [6, 2, 1, "", "TestDocumentation"], [6, 2, 1, "", "VarType"], [6, 2, 1, "", "VariableDocumentation"]], "cminx.documentation_types.AbstractCommandDefinitionDocumentation": [[6, 3, 1, "", "has_kwargs"], [6, 3, 1, "", "params"]], "cminx.documentation_types.AttributeDocumentation": [[6, 3, 1, "", "default_value"], [6, 3, 1, "", "parent_class"], [6, 4, 1, "", "process"]], "cminx.documentation_types.CTestDocumentation": [[6, 4, 1, "", "process"]], "cminx.documentation_types.ClassDocumentation": [[6, 3, 1, "", "attributes"], [6, 3, 1, "", "constructors"], [6, 3, 1, "", "inner_classes"], [6, 3, 1, "", "members"], [6, 4, 1, "", "process"], [6, 3, 1, "", "superclasses"]], "cminx.documentation_types.DanglingDoccomment": [[6, 4, 1, "", "process"]], "cminx.documentation_types.DocumentationType": [[6, 3, 1, "", "doc"], [6, 3, 1, "", "name"], [6, 4, 1, "", "process"]], "cminx.documentation_types.FunctionDocumentation": [[6, 4, 1, "", "process"]], "cminx.documentation_types.GenericCommandDocumentation": [[6, 3, 1, "", "params"], [6, 4, 1, "", "process"]], "cminx.documentation_types.MacroDocumentation": [[6, 4, 1, "", "process"]], "cminx.documentation_types.MethodDocumentation": [[6, 3, 1, "", "is_constructor"], [6, 3, 1, "", "is_macro"], [6, 3, 1, "", "param_types"], [6, 3, 1, "", "params"], [6, 3, 1, "", "parent_class"], [6, 4, 1, "", "process"]], "cminx.documentation_types.ModuleDocumentation": [[6, 4, 1, "", "process"]], "cminx.documentation_types.OptionDocumentation": [[6, 3, 1, "", "help_text"], [6, 4, 1, "", "process"]], "cminx.documentation_types.SectionDocumentation": [[6, 4, 1, "", "process"]], "cminx.documentation_types.TestDocumentation": [[6, 3, 1, "", "expect_fail"], [6, 3, 1, "", "is_macro"], [6, 3, 1, "", "params"], [6, 4, 1, "", "process"]], "cminx.documentation_types.VarType": [[6, 3, 1, "", "LIST"], [6, 3, 1, "", "STRING"], [6, 3, 1, "", "UNSET"]], "cminx.documentation_types.VariableDocumentation": [[6, 4, 1, "", "process"], [6, 3, 1, "", "type"], [6, 3, 1, "", "value"]], "cminx.documenter": [[7, 2, 1, "", "Documenter"]], "cminx.documenter.Documenter": [[7, 3, 1, "", "aggregator"], [7, 3, 1, "", "input_stream"], [7, 3, 1, "", "lexer"], [7, 3, 1, "", "module"], [7, 3, 1, "", "module_name"], [7, 3, 1, "", "parser"], [7, 4, 1, "", "process"], [7, 4, 1, "", "process_docs"], [7, 3, 1, "", "settings"], [7, 3, 1, "", "stream"], [7, 3, 1, "", "walker"], [7, 3, 1, "", "writer"]], "cminx.exceptions": [[8, 5, 1, "", "CMakeSyntaxException"]], "cminx.exceptions.CMakeSyntaxException": [[8, 3, 1, "", "line"], [8, 3, 1, "", "msg"]], "cminx.parser": [[10, 0, 0, "-", "CMakeLexer"], [11, 0, 0, "-", "CMakeListener"], [12, 0, 0, "-", "CMakeParser"], [13, 0, 0, "-", "CMakeVisitor"]], "cminx.rstwriter": [[14, 2, 1, "", "Directive"], [14, 2, 1, "", "DirectiveHeading"], [14, 2, 1, "", "DocTest"], [14, 2, 1, "", "Field"], [14, 2, 1, "", "Heading"], [14, 2, 1, "", "ListType"], [14, 2, 1, "", "Option"], [14, 2, 1, "", "Paragraph"], [14, 2, 1, "", "RSTList"], [14, 2, 1, "", "RSTWriter"], [14, 2, 1, "", "SimpleTable"], [14, 1, 1, "", "get_indents"], [14, 1, 1, "", "interpreted_text"]], "cminx.rstwriter.Directive": [[14, 4, 1, "", "build_heading"], [14, 4, 1, "", "format_arguments"], [14, 4, 1, "", "option"], [14, 4, 1, "", "to_text"]], "cminx.rstwriter.DirectiveHeading": [[14, 4, 1, "", "build_heading_string"]], "cminx.rstwriter.DocTest": [[14, 4, 1, "", "build_doctest_string"]], "cminx.rstwriter.Field": [[14, 4, 1, "", "build_field_string"]], "cminx.rstwriter.Heading": [[14, 4, 1, "", "build_heading_string"]], "cminx.rstwriter.ListType": [[14, 3, 1, "", "BULLETED"], [14, 3, 1, "", "ENUMERATED"]], "cminx.rstwriter.Option": [[14, 4, 1, "", "build_option_string"]], "cminx.rstwriter.Paragraph": [[14, 4, 1, "", "build_text_string"]], "cminx.rstwriter.RSTList": [[14, 4, 1, "", "build_list_string"]], "cminx.rstwriter.RSTWriter": [[14, 4, 1, "", "build_heading"], [14, 4, 1, "", "bulleted_list"], [14, 4, 1, "", "clear"], [14, 4, 1, "", "directive"], [14, 4, 1, "", "doctest"], [14, 4, 1, "", "enumerated_list"], [14, 4, 1, "", "field"], [14, 3, 1, "", "heading_level_chars"], [14, 4, 1, "", "section"], [14, 4, 1, "", "simple_table"], [14, 4, 1, "", "text"], [14, 4, 1, "", "to_text"], [14, 4, 1, "", "write_to_file"]], "cminx.rstwriter.SimpleTable": [[14, 4, 1, "", "build_table_string"]]}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "function", "Python function"], "2": ["py", "class", "Python class"], "3": ["py", "attribute", "Python attribute"], "4": ["py", "method", "Python method"], "5": ["py", "exception", "Python exception"]}, "objtypes": {"0": "py:module", "1": "py:function", "2": "py:class", "3": "py:attribute", "4": "py:method", "5": "py:exception"}, "terms": {"": [1, 2, 6, 7, 14, 18, 21, 25, 27, 29, 32, 35, 36, 38, 39, 40, 42], "0": [0, 2, 6, 7, 14, 25, 39, 41], "1": [0, 1, 6, 9, 14, 25, 28, 32, 34, 39], "10": [0, 25], "11": 38, "13": 38, "14": [0, 25], "15": 0, "19": 0, "2": [2, 6, 7, 14, 25, 28, 35, 37, 39], "2013": 0, "2018": 0, "2019": 0, "2020": [0, 25], "20201": 0, "2021": 0, "2022": 38, "21": 0, "25": 0, "26": 0, "3": [0, 1, 6, 25, 39], "4": [1, 25, 39], "45": 38, "5": 35, "6": 0, "7": [0, 25], "8": 0, "9": [0, 25], "A": [0, 1, 2, 6, 8, 14, 25, 32, 35, 39, 41, 42], "And": 30, "As": [0, 25, 28, 32, 35, 38], "By": [1, 7, 16], "For": [1, 6, 28, 29, 30, 31, 32, 34, 36, 38, 40, 42], "If": [0, 1, 2, 6, 14, 29, 32, 38, 40, 42], "In": [0, 1, 25, 28, 32, 35, 38, 40], "It": [0, 1, 2, 6, 7, 16, 25, 27, 29, 35, 38, 40], "Its": 6, "Of": [0, 25, 32], "One": [1, 35], "The": [1, 2, 3, 5, 6, 7, 8, 14, 16, 21, 23, 25, 26, 27, 28, 29, 32, 34, 35, 36, 37, 38, 39, 40, 41, 42], "Then": 42, "There": [0, 35, 38], "These": [6, 15, 25], "To": [25, 36, 38, 39], "With": 39, "_": [1, 2, 3, 7, 14], "__init__": 25, "__pycache__": 1, "_abc_": 1, "_asht": [32, 34], "_asht_cat": [32, 34], "_asht_person": [32, 34], "_cgd_dir": 17, "_cgd_output": 17, "_find_requir": 18, "_static": 38, "_templat": 38, "abandon": 0, "abc": 1, "abil": 25, "abl": [0, 35], "about": [0, 25, 32, 36, 38, 39], "abov": 35, "abstract": 6, "abstractcommanddefinitiondocument": [2, 6], "accept": [6, 32], "access": 2, "accident": 35, "accomplish": 25, "accord": [0, 36, 38, 42], "account": [25, 32, 34], "achiev": 25, "acquir": 0, "act": 6, "activ": 40, "actual": [0, 6, 8, 29, 40], "ad": [6, 7, 14, 27, 29, 38], "adapt": 38, "add": [0, 1, 6, 14, 28, 34, 38], "add_librari": 2, "add_test": [1, 2, 6, 31], "addit": [1, 2, 17, 25, 36, 42], "adjust": 35, "admonit": 14, "advanc": [32, 35], "advanced_macro": 34, "advanced_macro_say_hi": 34, "advanced_module_nam": 35, "advanced_say_hi_to": 32, "advis": 35, "affect": [1, 35], "aforement": 32, "after": [25, 28, 32, 35, 36, 39], "afterward": 38, "again": [30, 31], "against": 25, "aggreg": [4, 5, 7, 27], "aid": 25, "akin": 36, "alia": 2, "all": [0, 1, 2, 4, 5, 6, 7, 14, 15, 28, 32, 42], "allow": [35, 36, 38], "almost": 14, "along": [26, 38], "alphabet": 29, "alreadi": [2, 25, 38], "also": [0, 1, 2, 4, 6, 7, 17, 25, 26, 32, 35, 38], "although": [32, 35], "alwai": 16, "am": 36, "among": 32, "an": [0, 1, 2, 6, 7, 8, 14, 25, 26, 28, 32, 35, 36, 37, 38, 40], "analog": [25, 30, 31], "analysi": 8, "ani": [1, 2, 6, 25, 32, 35], "annot": 36, "anoth": [2, 14, 32, 38], "answer": [0, 38], "anticip": 25, "antlr": 25, "antlr4": [2, 27, 28], "anyth": [1, 32, 36], "anywher": 14, "apach": [2, 6, 7, 14], "api": [1, 14, 27, 38], "appear": [14, 25, 32, 35, 36], "append": 1, "applic": [2, 14], "appropri": 26, "ar": [0, 1, 2, 6, 14, 15, 17, 23, 25, 26, 27, 28, 29, 32, 33, 35, 36, 38, 39, 40, 42], "arg": [2, 9, 14, 17], "arguabl": [25, 38], "argument": [2, 6, 9, 14, 33, 34, 35, 42], "argv": 9, "around": 25, "arrai": 9, "ascertain": 32, "asctim": 1, "ask": 0, "aspect": 32, "asset": 29, "assign": 21, "associ": [2, 6, 14], "assort": 6, "assum": [1, 33, 38, 41], "attach": [6, 35], "attempt": 1, "attribut": [1, 6], "attributedocument": 6, "august": 0, "author": [0, 1, 2, 6, 7, 14], "auto": 1, "auto_exclude_directories_without_cmak": [1, 2, 3, 7, 14], "autodoc": 0, "autogener": [35, 36], "automat": [1, 25, 32, 34, 42], "avail": [0, 25], "awai": 0, "await": 2, "b": 40, "back": [0, 16], "background": 39, "bar": [38, 40, 41], "bare": 0, "base": [6, 14, 35, 38], "bash": 38, "basic": [1, 33, 34, 35, 36, 38], "basic_macro": 34, "basic_modul": 35, "bat": 38, "becaus": [0, 14, 35], "been": [0, 2, 25], "befor": [4, 14, 29, 35], "begin": [2, 42], "behav": 34, "being": [0, 2, 14, 25, 34, 39], "below": [1, 42], "besid": 14, "best": 38, "beta": 0, "between": [1, 5, 36], "beyond": [25, 32], "biggest": 34, "bin": 40, "binari": 0, "blank": [32, 35, 41], "blob": 0, "block": [0, 36, 39, 42], "bodi": [1, 35], "bone": 0, "bool": [2, 3, 6], "boolean": 32, "borrow": 36, "both": [1, 2, 42], "brad": 0, "branch": 16, "branden": [2, 6, 7, 14], "brief": [32, 41], "briefli": 29, "broken": 36, "bruxisma": 0, "build": [1, 7, 9, 14, 25, 29, 31, 38, 40], "build_dir": 40, "build_doctest_str": 14, "build_field_str": 14, "build_head": 14, "build_heading_str": 14, "build_list_str": 14, "build_option_str": 14, "build_table_str": 14, "build_text_str": 14, "builtin": 0, "bullet": 14, "bulleted_list": 14, "burner": 0, "butler": [2, 6, 7, 14], "c": [39, 40], "cach": 6, "call": [1, 2, 6, 7, 14, 28, 30, 31, 32, 35], "can": [1, 2, 6, 14, 17, 26, 30, 31, 32, 35, 36, 38, 39, 40, 42], "caption": 38, "case": [1, 29, 30, 31, 42], "cat": [32, 34], "categori": [1, 36], "caus": 1, "cd": 40, "chang": [1, 16, 29, 38], "channel": 40, "charact": [1, 6, 14, 36], "check": 25, "choic": 40, "choos": [38, 42], "chose": 38, "chosen": 2, "ci": [25, 27, 29], "circumst": 25, "class": [1, 2, 3, 6, 7, 14, 39], "classdocument": [2, 6], "clean": [2, 6, 28], "clear": 14, "clearli": 32, "clone": [29, 40], "close": [32, 36, 39], "cmake": [1, 2, 4, 5, 6, 7, 8, 9, 26, 27, 28, 29, 31, 32, 33, 34, 35, 36, 39, 41, 42], "cmake_api": 38, "cmake_current_list_dir": 38, "cmake_current_source_dir": 21, "cmake_install_prefix": 40, "cmake_parse_argu": [1, 2, 32, 34], "cmakelex": 7, "cmakelist": 29, "cmakelisten": 2, "cmakepars": [2, 7, 28], "cmakepp": [1, 6, 38, 40], "cmakesyntaxexcept": 8, "cmaketest": [1, 2, 6, 31, 33, 39], "cminx": [22, 27, 30, 31, 32, 34, 35, 36, 37, 40, 41, 42], "cminx_gen_rst": [17, 22, 38], "code": [0, 1, 8, 14, 16, 25, 26, 29, 32, 35, 36, 38, 39], "codecov": 29, "collis": 1, "column": 14, "column_head": 14, "com": [0, 38, 40], "combin": [1, 7], "command": [0, 1, 2, 6, 15, 25, 28, 30, 31, 32, 34, 35, 37, 40, 42], "command_invocationcontext": 2, "command_nam": 2, "comment": [6, 30, 31, 32, 33, 35, 37, 39, 41, 42], "commit": 0, "common": [32, 39], "comparison": 36, "compat": [25, 42], "compil": 25, "complet": [7, 14, 28, 38], "compon": [7, 35, 36], "conceptu": 25, "config": [1, 25, 42], "config_default": [3, 25], "config_templ": 3, "configur": [6, 25, 32, 35, 39], "confin": 25, "confus": [1, 3, 27], "consid": [2, 5, 25, 32, 35, 36], "consist": 8, "consol": 1, "constitut": 29, "construct": [2, 14], "constructor": [1, 2, 6], "consum": [2, 14], "contain": [0, 1, 2, 3, 4, 5, 6, 7, 9, 14, 21, 26, 29, 32, 36, 38], "content": [1, 14, 26, 28, 29, 36, 38], "context": [2, 28, 32], "continu": [18, 25], "control": [1, 29, 40], "conveni": 38, "convent": [32, 36], "convert": [3, 6, 32], "copi": 32, "core": 25, "corr_rst": 26, "correct": [14, 29], "correctli": [14, 34], "correspond": [14, 28], "could": 25, "coupl": [25, 38], "cov": 27, "cover": 16, "coverag": 27, "cpp_attr": 2, "cpp_class": 2, "cpp_end_class": 2, "cpp_member": 2, "creat": [1, 2, 6, 23, 31, 38, 39, 40], "creation": 0, "critic": 25, "cross": 0, "ct_add_sect": 30, "ct_add_test": [2, 30], "ct_test": 30, "ctest": [1, 2, 6], "ctest_add_test": 31, "ctestdocument": 6, "ctx": 2, "current": [1, 2, 3, 14, 41, 42], "custom": [0, 1, 18, 41], "cut": 25, "d": 0, "dai": 0, "dangl": 6, "danglingdoccom": 6, "data": [6, 14, 37], "dataclass": [2, 6], "date": 26, "de": 25, "debug": 1, "decid": 38, "decis": 27, "declar": [2, 6, 35, 37], "dedic": 2, "default": [2, 3, 6, 7, 25, 32, 37, 38, 39, 42], "default_valu": 6, "defin": [1, 2, 6, 7, 32, 38, 41], "definit": [1, 2, 6, 28, 30, 31], "definition_command_stack": 2, "definitioncommand": 2, "denot": 8, "depend": [2, 27, 29, 39, 42], "depth": [1, 32], "deriv": 14, "describ": [0, 6, 8, 25, 32], "descript": [32, 36, 41], "design": [16, 27, 40], "desir": [14, 32], "detail": [1, 25, 32, 41], "detect": [4, 8], "determin": [2, 21, 25, 29, 34], "dev": 0, "develop": [0, 14, 15, 16, 25, 26, 29, 39, 40], "diagrammat": 28, "dict": [1, 3], "dictionari": 3, "did": 27, "differ": [6, 14, 32, 34, 35, 36], "dimension": 14, "dir": [3, 17], "direct": [0, 1, 6, 7, 14, 33, 35, 36, 38], "directivehead": 14, "directli": [1, 6, 14, 32, 35], "directori": [0, 1, 2, 3, 4, 5, 7, 14, 17, 21, 26, 29, 39, 40, 41, 42], "dispatch": 2, "displai": 29, "distinguish": [32, 36], "dive": 27, "do": [0, 1, 25, 30, 31, 32, 34, 36, 38, 39, 40], "doc": [0, 1, 6, 7, 25, 26, 29, 32, 35, 39, 42], "doccom": [1, 2, 6, 7, 28, 35, 36], "docstr": [2, 28, 39], "doctest": 14, "doctest_str": 14, "document": [0, 1, 2, 5, 6, 9, 14, 17, 28, 29, 36, 38, 39, 41, 42], "document_single_fil": 4, "documentation_typ": [2, 7], "documentationaggreg": [2, 7], "documentationtyp": [2, 6, 7], "documented_awaiting_function_def": 2, "documented_classes_stack": 2, "documented_command": 28, "documented_commandcontext": 2, "docutil": [27, 42], "dodgi": 38, "doe": [1, 2, 3, 6, 14, 19, 20, 25, 32, 34, 35, 36, 38], "domain": 39, "domin": 25, "done": [0, 30, 31, 38], "down": [4, 5, 7, 25], "downstream": 7, "doxygen": [0, 39], "drawback": 25, "due": 35, "e": [0, 1, 2, 6, 14, 30, 31, 32, 38, 40, 42], "each": [3, 6, 14, 16, 28, 42], "easi": 0, "easier": [27, 29], "easili": 38, "echo": 31, "edit": 40, "effect": 25, "either": 14, "element": [2, 14, 28, 35, 42], "els": 36, "email": 0, "empti": [6, 14], "en": [0, 29], "encompass": 32, "encount": [1, 2], "end": [2, 25, 32, 36, 42], "endfunct": [30, 32, 35, 36, 41], "endmacro": 34, "enough": 25, "ensur": [14, 16, 26, 35], "enter": [28, 38], "entercommand_invoc": 2, "enterdocumented_command": [2, 28], "entir": [6, 36], "entireti": 0, "entiti": 6, "entri": [9, 25, 29], "entrypoint": [2, 7], "enumer": 14, "enumerated_list": 14, "env": 40, "environ": [0, 23, 40], "envis": [0, 25], "equal": [14, 35], "equival": [14, 28, 40], "eras": 1, "error": [8, 35], "establish": 39, "etc": [0, 1, 6, 16, 25], "evalu": 14, "even": [32, 34, 35], "ever": 25, "everyth": 36, "ex": [6, 14], "exact": 14, "exactli": [6, 25], "exampl": [1, 2, 21, 26, 28, 30, 31, 32, 34, 36, 37, 39], "example_test": 31, "except": [6, 32, 37], "exclud": [1, 9, 25, 42], "exclude_filt": [1, 2, 3, 7, 14, 42], "execut": [1, 14, 18, 28, 29, 31, 40], "exercis": 25, "exhaust": 25, "exist": [0, 1, 6, 25, 38, 39], "exit": [28, 42], "expect": [6, 8, 14, 25], "expect_fail": 6, "expected_output": 14, "expectfail": [6, 30], "explain": 29, "expos": 1, "express": 32, "ext": 1, "extend": 25, "extens": [0, 1, 25, 38, 42], "extract": [0, 2, 25, 28, 36, 39], "extractor": 0, "facilit": 25, "fact": [32, 34], "facto": 25, "factori": [3, 6], "fail": [6, 35], "fals": [1, 2, 3, 6, 7, 14], "familiar": 33, "fanci": [32, 36], "fast": 25, "favor": 0, "featur": [25, 27, 34], "fed": 28, "feel": [0, 38], "fetchcont": 38, "fetchcontent_declar": 38, "fetchcontent_makeavail": [25, 38], "few": 35, "field": [2, 6, 14, 32], "field_nam": 14, "field_str": 14, "field_text": 14, "fig": 28, "figur": 29, "file": [0, 3, 4, 5, 7, 8, 14, 17, 18, 25, 26, 29, 32, 35, 36, 38, 39, 41, 42], "file_extensions_in_modul": [1, 2, 3, 7, 14], "file_extensions_in_titl": [1, 2, 3, 7, 14], "filehandl": 1, "filenam": [1, 35, 42], "filepath": 14, "filestream": 28, "filesystem": 14, "fill": 38, "filter": [1, 25], "final": [32, 38], "find_python_modul": [15, 22], "finish": [0, 38], "first": [1, 14, 18, 32, 35, 36, 38], "fit": 6, "fix": 39, "float": 32, "focus": 38, "folder": [26, 29], "follow": [0, 1, 26, 27, 29, 32, 34, 35, 38, 40], "follow_symlink": [1, 2, 3, 7, 14], "foo": [38, 40, 41], "fork": 0, "form": [6, 14], "format": [1, 9, 14, 16, 32, 34, 36], "format_argu": 14, "format_python": 16, "formatt": 1, "forward": [1, 17, 32], "found": [2, 18, 32], "four": 1, "free": 38, "friendli": 25, "from": [0, 1, 2, 5, 6, 7, 14, 17, 25, 28, 32, 34, 35, 36, 40, 41, 42], "full": [1, 6, 23, 25, 40], "fulli": 14, "function": [0, 1, 2, 3, 6, 14, 18, 27, 28, 30, 31, 33, 34, 35, 36, 37, 39, 40, 41, 42], "function_parameter_name_strip_regex": [1, 2, 3, 7, 14], "functiondocument": [6, 28], "futur": [25, 29], "g": [1, 14, 38], "g4": 28, "gener": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 14, 17, 25, 26, 28, 30, 31, 32, 34, 35, 36, 37, 38, 41, 42], "genericcommanddocument": 6, "genindex": 38, "get": [0, 14, 26, 29, 32], "get_cmaiz": [15, 22], "get_cmake_test": [15, 22], "get_ind": 14, "get_version_from_git": [15, 22], "git": [21, 29, 38, 40], "git_repositori": 38, "github": [0, 16, 29, 38, 40], "gitignor": [25, 29], "gitlab": 0, "given": [0, 2, 6, 7, 35, 40], "glob": 42, "go": [0, 38, 40], "goe": 32, "good": 32, "grammar": 28, "greater": 35, "greet": 34, "guarante": 8, "guidanc": 25, "gvfg_git_root": 21, "gvfg_result": 21, "h": 42, "ha": [0, 1, 6, 14, 25, 32, 34, 35, 36, 38, 39], "halt": 8, "hand": 4, "handl": [7, 32], "handler": [1, 4], "has_kwarg": [2, 6], "have": [1, 2, 14, 25, 32, 35, 38, 39, 42], "haven": 0, "head": 14, "header": [1, 2, 3, 5, 7, 14, 36, 42], "header_char": 14, "heading_level_char": 14, "heading_str": 14, "heavili": 35, "held": 14, "hello": [6, 31], "help": [0, 2, 6, 25, 35, 42], "help_text": 6, "henc": 1, "here": [1, 32, 35], "hi": [32, 34, 36], "highest": 1, "highli": 38, "highlight": 0, "hint": 36, "histor": 0, "hold": 6, "honor": 40, "hood": 1, "hope": [27, 29], "host": 0, "hous": 38, "how": [0, 1, 26, 27, 30, 31, 32, 35, 36, 38], "howev": [25, 32, 35], "howto": 1, "html": [0, 1, 9, 32, 38], "http": [0, 1, 29, 38, 40], "human": 25, "hurt": 1, "i": [0, 1, 2, 3, 6, 7, 8, 14, 15, 16, 18, 19, 20, 21, 25, 26, 27, 28, 29, 30, 31, 32, 34, 35, 36, 37, 38, 39, 40, 41, 42], "ideal": [25, 32, 36, 39], "ident": 37, "identifi": 6, "ignor": [2, 35], "immedi": 35, "implement": [6, 32], "impli": 6, "implicitli": 32, "import": [1, 38], "includ": [0, 1, 2, 6, 26, 32, 34, 38, 39], "include_guard": [35, 36], "include_undocumented_add_test": [1, 2, 3, 7, 14], "include_undocumented_cpp_attr": [1, 2, 3, 7, 14], "include_undocumented_cpp_class": [1, 2, 3, 7, 14], "include_undocumented_cpp_constructor": [1, 2, 3, 7, 14], "include_undocumented_cpp_memb": [1, 2, 3, 7, 14], "include_undocumented_ct_add_sect": [1, 2, 3, 7, 14], "include_undocumented_ct_add_test": [1, 2, 3, 7, 14], "include_undocumented_funct": [1, 2, 3, 7, 14], "include_undocumented_macro": [1, 2, 3, 7, 14], "include_undocumented_opt": [1, 2, 3, 7, 14], "incompat": [25, 42], "inconsist": 14, "incorrect": 25, "increas": 25, "indent": 14, "independ": 0, "index": [1, 4, 14, 39], "indic": [36, 38], "infinit": 1, "info": 1, "inform": [0, 2, 3, 6, 28, 36], "infrastructur": [25, 29], "initi": [1, 39], "inner": [2, 6], "inner_class": 6, "input": [1, 2, 3, 7, 14, 25, 35, 42], "input_fil": 4, "input_stream": 7, "inputset": [2, 3, 7, 14], "inputstream": 7, "insensit": [29, 42], "insid": [1, 2, 38], "instal": [23, 25, 29, 38, 39], "instanc": [2, 6, 7], "instead": [1, 32, 35], "instruct": 38, "int": [8, 14], "integ": 32, "integr": [25, 38], "intention": 35, "interact": 14, "interest": 29, "interfac": [2, 14], "intermedi": 14, "intern": 0, "interpret": [14, 18, 23, 32, 35], "interpreted_text": 14, "intersphinx": 0, "introduc": [19, 20, 34], "inv": 0, "invalid": 14, "invoc": [2, 6], "invok": 1, "io": [14, 29], "irrelev": 38, "is_constructor": [2, 6], "is_macro": 6, "item": 14, "item1": 6, "item2": 6, "item3": 6, "its": [2, 6, 14, 25, 32, 35, 38], "itself": [0, 1, 25, 32], "keep": [29, 39], "keyword": [1, 6, 33, 34], "kick": 7, "king": 0, "kitwar": 0, "know": 25, "knowledg": [6, 39], "kwarg": [1, 2, 3, 7, 14, 18, 32, 34], "kwargs_doc_trigger_str": [1, 2, 3, 7, 14], "languag": [0, 25, 26, 32, 39], "larg": [6, 25], "last": [0, 1, 2, 42], "later": 25, "latest": [25, 29], "latter": 32, "least": [1, 35, 38, 41], "left": [6, 14], "leftmost": 14, "legaci": 0, "length": 14, "less": [25, 32], "let": [1, 25], "letter": [1, 14], "level": [1, 7, 14, 27, 42], "levelnam": 1, "lexer": [7, 8, 28], "librari": [1, 25], "licens": [2, 6, 7, 14, 29], "lift": 25, "like": [0, 1, 14, 25, 26, 29, 32, 35, 36, 38, 41, 42], "limit": 14, "line": [1, 8, 14, 32, 34, 35, 36, 38, 41, 42], "link": [0, 6, 38], "lint": 27, "linux": 42, "list": [1, 2, 3, 6, 7, 9, 14, 15, 28, 29, 32, 34, 37], "list_str": 14, "list_typ": 14, "list_var": 6, "listen": [2, 7], "listtyp": 14, "liter": 14, "literalinclud": 26, "littl": 1, "live": [1, 25, 26, 38, 40], "load": [1, 25, 42], "local": [14, 25], "locat": [1, 2, 4, 7, 8, 18, 28, 38, 41], "lock": 25, "log": [2, 3, 7, 14, 39], "logfil": 1, "logger": 1, "logger_config": [2, 3, 7, 14], "loggingset": [2, 3, 7, 14], "long": 1, "longer": [6, 25, 32], "look": [0, 25, 35, 36, 38], "loop": [6, 7, 28], "m": [9, 40], "macro": [0, 1, 2, 6, 19, 20, 33, 37, 39, 41], "macro_parameter_name_strip_regex": [1, 2, 3, 7, 14], "macro_say_hi": 34, "macrodocument": 6, "made": 27, "mai": [0, 8, 14, 29, 32, 34, 35, 36], "main": [1, 2, 25, 26, 29, 38], "maintain": [0, 16], "major": 25, "make": [0, 14, 23, 27, 29, 38], "make_python_venv": [22, 23], "makefil": 38, "malform": 25, "man": 0, "manag": [1, 16, 25], "mani": [1, 32, 38], "manner": 34, "manual": [0, 6, 25, 30, 31], "map": 32, "mark": 36, "master": [0, 16, 38], "match": [1, 14, 25], "maxdepth": [14, 38], "mayb": [32, 34], "md": 29, "me": [32, 34, 36], "mean": [0, 1, 32, 35, 38], "meant": [0, 15, 16, 25, 27], "measur": 25, "mechan": 39, "member": [1, 2, 6], "member_parameter_name_strip_regex": [1, 2, 3, 7, 14], "messag": [1, 8, 21, 32, 34, 36, 41, 42], "method": [2, 6, 7, 14, 28, 40], "methoddocument": [2, 6], "minimum": 25, "mirror": [0, 3], "mode": [1, 14], "model": 39, "modern": 32, "modifi": [1, 28], "modindex": 38, "modul": [0, 1, 2, 6, 7, 14, 18, 23, 25, 27, 30, 31, 32, 33, 34, 36, 37, 38, 39, 41], "module_nam": 7, "module_path_separ": [1, 2, 3, 7, 14], "module_upp": 18, "moduledocument": 6, "moment": 0, "more": [1, 25, 32, 35, 38, 41], "moreov": 25, "most": [14, 25, 29, 32, 38, 39], "mpv_ex": 23, "mpv_venv": 23, "mr": 0, "msg": 8, "much": 35, "multipl": [14, 25, 32, 34], "must": [14, 35, 36, 41], "my": [21, 36], "my_project_vers": 21, "mylist": 37, "myvar": 6, "name": [0, 1, 2, 6, 7, 9, 14, 18, 21, 23, 25, 26, 30, 31, 32, 34, 35, 36, 38, 40], "name_of_param": 32, "namedtupl": 28, "namespac": 1, "nativ": 32, "natur": 25, "necessari": [4, 5, 14, 32], "need": [1, 25, 29, 36, 38], "nest": 1, "new": [14, 19, 20, 26, 34], "newer": 25, "next": [32, 38], "nice": 25, "non": [1, 35], "none": [2, 3, 6, 7, 14, 37], "nonzero": 14, "normal": [25, 36, 39, 40], "note": [0, 2, 6, 8, 16, 26, 31, 32, 34, 38], "noth": 14, "notic": 32, "notimplementederror": 2, "now": 38, "nuanc": 32, "num": 14, "number": [14, 25, 32, 42], "o": [25, 38, 41, 42], "object": [0, 2, 3, 4, 5, 6, 7, 14, 32], "obligatori": 29, "obtus": 35, "obviou": 32, "occur": [1, 35], "off": [4, 7, 32], "offici": 39, "often": 32, "older": [25, 35], "one": [0, 1, 6, 14, 25, 32, 34, 35, 38, 40, 41], "ones": 32, "onli": [0, 1, 6, 8, 25, 32, 35], "onlin": 0, "open": [14, 25, 35], "oper": [25, 42], "opt": [25, 38], "option": [0, 2, 6, 14, 18, 32, 35, 36, 39, 42], "option_str": 14, "optiondocument": [2, 6], "order": [1, 25, 29], "org": [0, 1], "organ": 0, "organiz": 1, "orient": 14, "origin": [1, 42], "other": [1, 2, 6, 14, 25, 30, 31, 32, 35], "our": [7, 25, 27, 29, 38, 39, 40], "out": [1, 29, 32, 38], "output": [1, 2, 3, 5, 7, 14, 17, 34, 36, 42], "output_dir": [5, 38, 41], "output_dir_relative_to_config": 3, "outputset": [2, 3, 7, 14], "over": [4, 6, 7, 28], "overlin": 14, "overrid": [1, 35, 42], "overridden": [1, 35], "overview": 27, "overwritten": 14, "own": 0, "p": 42, "packag": [0, 23, 25, 40, 42], "page": [0, 16, 25, 26, 29, 38], "paragraph": [14, 32], "param": [2, 3, 5, 6, 7, 14, 32, 34, 36, 41], "param0": 41, "param1": 35, "param_typ": 6, "paramat": 18, "paramet": [1, 2, 3, 4, 5, 6, 7, 9, 14, 17, 18, 21, 23, 32, 41, 42], "parent": [1, 6], "parent_class": 6, "pars": [1, 2, 7, 25, 27, 32, 35, 36], "parse_argv": [32, 34], "parser": [2, 7, 8, 25, 28], "parsererrorlisten": 7, "parserrulecontext": 2, "parsetreewalk": [2, 7, 28], "part": [1, 2, 6, 25, 29, 32, 38, 40], "particular": [25, 38, 40], "partit": 1, "pass": [1, 4, 5, 6, 7, 28, 32, 36, 41], "path": [1, 5, 14, 23, 25, 32, 35, 38, 40, 42], "pathspec": 27, "peopl": [0, 32, 34], "per": 28, "perform": [4, 14, 25], "perhap": 0, "person": [32, 34, 36, 40], "perspect": 34, "pertain": [1, 16], "perus": 25, "pin": 25, "pip": [23, 25, 29, 40], "pip3": 40, "place": [1, 2, 5, 16, 32, 35], "pleas": 29, "plugin": 25, "point": [1, 9, 25, 29, 32], "pop": 2, "popul": 14, "posit": [2, 32, 42], "possibl": [0, 1, 25, 38], "postfix": 1, "pr": 16, "practic": [32, 39], "preced": 37, "prefer": [1, 35, 38, 40], "prefix": [1, 2, 3, 7, 14, 42], "prepend": 42, "preprocess": 4, "preprocessor": 36, "present": [1, 14, 35, 36], "pretti": 0, "prevent": 1, "primari": 2, "primarili": [27, 29], "primit": 6, "print": 42, "prior": 0, "prioriti": 1, "probabl": 25, "problem": 25, "procedur": 14, "proceed": [30, 31], "process": [2, 6, 7, 23, 25, 26, 28, 34, 35, 37], "process_": 2, "process_add_test": 2, "process_cmake_parse_argu": 2, "process_cpp_attr": 2, "process_cpp_class": 2, "process_cpp_constructor": 2, "process_cpp_memb": 2, "process_ct_add_sect": 2, "process_ct_add_test": 2, "process_doc": 7, "process_funct": [2, 28], "process_generic_command": 2, "process_macro": 2, "process_opt": 2, "process_set": 2, "processor": 2, "produc": 40, "program": [8, 9, 25, 31, 42], "project": [0, 15, 21, 27, 38], "propag": 1, "proper": 16, "properli": [16, 38], "properti": 1, "provid": [0, 1, 6, 14, 25, 32, 40], "publish": 0, "pull": 32, "pure": [14, 40], "purpos": [1, 25, 29, 38], "push": 16, "put": [1, 16, 26, 29, 32, 38], "pvpi_modul": 23, "pvpi_venv": 23, "py": [6, 25, 29], "py_": 18, "pypa": 29, "pypi": [0, 40], "pytest": 27, "python": [1, 14, 16, 18, 23, 27, 32, 39], "python3": 40, "python_venv_pip_instal": [22, 23], "python_virt_env": [15, 22], "question": [0, 38], "quickli": 32, "quickstart": [38, 39], "r": [38, 42], "rais": [2, 14], "rather": 31, "read": [7, 25, 28, 38], "readabl": 25, "readm": 29, "real": 14, "realiz": 1, "realli": 25, "reason": [0, 40], "recal": 27, "receiv": 0, "recogn": [1, 6, 25, 32], "recommend": [1, 33, 38, 40], "recover": 8, "recurs": [1, 2, 3, 7, 14, 42], "ref": 38, "refer": [0, 38, 42], "reflect": 2, "regard": 1, "regardless": [1, 32, 38], "regex": 1, "regular": [6, 14], "rel": [1, 3, 5, 35, 38, 42], "relat": [1, 25], "relative_to_config": [1, 2, 3, 7, 14], "releas": 0, "relev": [2, 25, 28, 40], "reli": 1, "render": 32, "replac": [1, 42], "repli": 0, "repo": [0, 21, 27], "report": 25, "repositori": 38, "repres": [2, 6, 14, 28, 36], "represent": [6, 14], "request": [0, 14], "requir": [0, 6, 14, 18, 25, 29, 35, 36], "resolv": [1, 3, 42], "respect": [5, 32, 42], "rest": [0, 1, 26, 33, 39, 41], "restrict": 25, "restructur": 25, "restructuredtext": [14, 33, 39], "result": [1, 21, 32, 35, 38, 40, 41], "return": [0, 7, 14, 32], "robust": 25, "role": [0, 14, 28], "root": [1, 5, 38], "row": 14, "rst": [0, 1, 2, 3, 4, 5, 6, 7, 14, 17, 26, 28, 34, 35, 36, 39, 41, 42], "rstlist": 14, "rstset": [2, 3, 7, 14], "rstwriter": [6, 7, 28], "rule": [2, 7, 28], "run": [0, 1, 15, 16, 25, 26, 32, 39, 40, 41, 42], "runtim": 28, "safe": 0, "sai": [0, 1, 6, 32, 34, 36, 41], "same": [9, 14, 25, 32, 34, 35, 39], "sampl": 26, "say_hi_to": [32, 36], "scan": 14, "scenario": 25, "scope": [19, 20, 25, 34], "script": [25, 38], "search": [1, 2, 17, 25, 38, 42], "second": 14, "section": [1, 2, 6, 14, 25, 30, 32], "section1": 30, "section_level": 14, "sectiondocument": 6, "see": [1, 25, 32, 35], "seem": 0, "seemingli": 0, "seen": 35, "segment": 14, "select": [1, 3, 6, 38], "self": 0, "sep": 38, "separ": [1, 32, 35, 38, 41], "serv": 6, "session": 14, "set": [1, 2, 3, 4, 5, 6, 7, 14, 18, 29, 32, 35, 37, 38, 39, 42], "setup": [0, 29, 38], "setuptool": 29, "shell": [38, 42], "short": 32, "should": [0, 1, 2, 3, 6, 7, 15, 25, 26, 29, 32, 35, 36, 38, 40], "should_docu": 2, "show": [0, 32, 35, 38, 42], "showcas": 26, "signatur": [0, 1, 25, 32, 34], "similar": [25, 32], "simpl": [1, 14, 32], "simple_t": 14, "simplet": 14, "simpli": [25, 35, 40], "simplic": 25, "sinc": [6, 32, 34], "singl": [2, 5, 6, 14, 17, 35, 37], "situat": 25, "skip": 38, "slower": 25, "so": [0, 2, 6, 8, 14, 19, 20, 32, 34, 35, 38], "softwar": [29, 39], "solo": 0, "solut": 39, "some": [0, 25, 38, 42], "someth": 38, "sometim": 36, "somewhat": 38, "sourc": [0, 1, 3, 5, 8, 9, 16, 17, 25, 26, 29, 35, 36, 38, 39, 40], "space": 14, "speak": 32, "special": [1, 6, 36], "specif": [0, 14, 38], "specifi": [1, 5, 6, 14, 18, 35, 42], "sphinx": [6, 27, 32, 35, 36, 39, 42], "sphinx_contrib": 0, "sphinx_rtd_them": 27, "stack": 2, "stackoverflow": 0, "stai": [26, 32, 36], "standard": [1, 28, 42], "star": 0, "start": [0, 36, 38], "state": [0, 6], "static": 25, "stdout": 1, "step": 39, "still": [0, 32, 34, 35, 36, 38], "sting": 32, "store": [6, 14, 17], "str": [2, 3, 4, 6, 7, 8, 9, 14, 37], "str_var": 6, "stream": [1, 7, 28], "streamhandl": 1, "strictli": 32, "string": [1, 2, 4, 6, 7, 9, 14, 32, 34, 36, 37], "strip": 1, "strongli": 32, "structur": [14, 27, 38], "stuff": 38, "style": [0, 25, 42], "subclass": 2, "subdirectori": [25, 42], "subhandl": 28, "subprocessor": 28, "subsect": 14, "subsequ": [32, 35], "substitut": 40, "suggest": [0, 38], "suit": [16, 25], "summar": [28, 32], "summari": 0, "summarili": 38, "superclass": [2, 6], "suppli": [32, 35], "support": [0, 1, 6, 25, 29, 32, 34, 37, 42], "suppos": 25, "switch": 32, "sy": [1, 9], "symlink": 1, "syntax": [0, 8, 14, 42], "system": [1, 7, 25, 38, 42], "t": 0, "tab": 14, "tabl": [14, 38], "table_str": 14, "tag": [35, 36], "take": [6, 32, 34], "taken": 38, "target": [0, 32], "templat": [3, 25, 32], "tend": 25, "termin": 40, "test": [1, 2, 6, 14, 16, 26, 27, 29, 33, 39], "test1": 30, "test_func": 35, "test_lin": 14, "test_sampl": [26, 30, 31, 34, 35, 37], "testdocument": 6, "text": [2, 6, 14, 25, 29, 32, 35, 42], "text_str": 14, "th": 41, "than": [1, 25, 32, 35], "thei": [0, 1, 2, 25, 29, 32, 36, 38], "them": [2, 28, 32, 36], "theme": 25, "therefor": 36, "thereof": 25, "thi": [0, 1, 2, 6, 7, 8, 14, 15, 16, 18, 19, 20, 25, 26, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42], "thing": 1, "those": [0, 1, 25, 32], "though": [1, 35], "three": [14, 32, 36], "through": [14, 32, 35, 36], "thrust": 25, "thu": [1, 32, 36, 38], "time": [14, 25, 40], "titl": [1, 7, 14, 35], "tjwrona1992": 0, "to_text": 14, "toctre": [14, 38], "toggl": 32, "token": [7, 28], "tokenstream": 7, "too": 38, "tool": [0, 25], "top": [2, 7, 27, 42], "topic": [14, 27], "translat": [6, 35], "treat": [14, 29, 36], "tree": [5, 7, 14, 28], "trigger": 1, "true": [1, 2, 3, 6, 7, 14, 18], "try": 32, "tupl": 14, "turn": [25, 29, 32], "tutori": 38, "two": [2, 14, 32, 34, 40], "txt": [1, 14, 29], "type": [2, 6, 14, 28, 32, 33, 34, 37, 39], "typeerror": 14, "u": 25, "ultim": [25, 40], "unawar": 36, "unchang": 35, "uncom": 1, "under": [1, 25], "underlin": 14, "undocu": 1, "unfilt": 6, "uniqu": 14, "unit": 26, "unix": 38, "unknown": 14, "unless": 40, "unlik": 32, "unset": [2, 6, 37], "until": 14, "unus": 6, "up": [0, 14, 25, 26, 32, 38, 39], "updat": [2, 26, 29, 32, 39], "upon": [1, 25, 28], "us": [0, 1, 2, 6, 7, 14, 15, 21, 23, 25, 29, 30, 31, 32, 34, 35, 36, 38, 39, 40], "usag": [0, 25, 28, 35, 39], "user": [0, 1, 6, 15, 29, 32, 34, 40], "usual": [8, 32, 35, 36, 38, 40], "v": 32, "v3": 0, "valid": [1, 14], "valu": [1, 2, 6, 14, 25, 32, 37], "valueerror": 14, "vanilla": [1, 2, 6, 31], "vararg": 14, "vari": 1, "variabl": [0, 2, 6, 21, 33, 39, 40, 42], "variabledocument": 6, "variat": [32, 34], "variou": [28, 29], "vartyp": 6, "ve": 41, "venv": 40, "verbatim": [17, 32], "veri": [32, 36, 38], "verif": 14, "verifi": 14, "version": [1, 14, 15, 21, 22, 25, 29, 32, 35, 42], "via": [0, 6, 7, 23, 28, 38, 40], "viewabl": 1, "virt": 40, "virtual": [23, 40], "visit": [3, 29], "visitor": 2, "visual": 35, "w": 1, "wa": [0, 2, 8, 32, 42], "wai": [0, 35, 38, 40], "walk": [7, 28], "walker": [7, 28], "want": [1, 25, 32, 34, 40], "warn": [6, 30, 31], "watcher": 0, "we": [0, 1, 2, 23, 25, 27, 29, 32, 34, 38, 40], "websit": [25, 38], "welcom": [0, 38], "well": [6, 16, 25], "were": [0, 25, 35], "what": [0, 1, 2, 3, 25, 29, 32, 36], "whatev": 32, "when": [1, 2, 6, 7, 14, 26, 29, 32, 34, 38], "whenev": 2, "where": [1, 8, 14, 29, 32, 38, 40], "wherea": 34, "whether": [1, 2, 3, 6, 25, 34], "which": [0, 1, 2, 7, 23, 25, 28, 29, 30, 31, 32, 34, 37, 38, 39, 40, 42], "while": [25, 32], "why": [25, 27], "wide": 25, "within": [1, 2, 6, 15], "without": [2, 35, 38], "work": [0, 1, 3, 25, 27, 38, 41, 42], "workflow": [16, 25, 29, 39, 40], "working_directori": 31, "would": [14, 28, 38, 42], "wrap": 23, "write": [0, 6, 7, 14, 25, 38, 39], "write_to_fil": 14, "writer": [4, 5, 6, 7, 14], "written": [14, 39], "www": 0, "xdg_config_hom": 42, "xxx": 38, "yaml": [1, 3, 16, 25, 42], "yml": [25, 29], "you": [0, 26, 29, 30, 32, 33, 34, 38, 40, 41, 42], "your": [0, 26, 32, 38, 39, 41, 42], "your_exampl": 26, "z": 1, "za": 1, "zero": 14}, "titles": ["CMinx Background", "Configuring CMinx", "cminx.aggregator", "cminx.config", "cminx.document", "cminx.document_single_file", "cminx.documentation_types", "cminx.documenter", "cminx.exceptions", "cminx.main", "cminx.parser.CMakeLexer", "cminx.parser.CMakeListener", "cminx.parser.CMakeParser", "cminx.parser.CMakeVisitor", "cminx.rstwriter", "CMinx API", "CMinx\u2019s CI", "cmake.cminx", "cmake.find_python_module", "cmake.get_cmaize", "cmake.get_cmake_test", "cmake.get_version_from_git", "cmake", "cmake.python_virt_env", "cmake.versions", "CMinx Dependencies", "Documenting CMinx", "Developer Documentation", "Overview of How CMinx Works", "CMinx Repo Structure", "Documenting a CMakeTest Test", "Documenting a CTest Test", "Documenting a Function", "Using CMinx to Document Your Code", "Documenting a Macro", "Documenting a Module", "Types of Comments", "Documenting a Variable", "Example CMinx/Sphinx Workflow", "CMinx", "Installing", "Quickstart", "Usage"], "titleterms": {"": [0, 16], "0": 38, "1": 38, "2": 38, "3": 38, "4": 38, "Of": 39, "The": 0, "With": 40, "about": 1, "ad": 26, "aggreg": [2, 28], "antlr4": 25, "api": 15, "argument": 32, "background": 0, "basic": 32, "build": 0, "call": 38, "ci": 16, "cmake": [0, 15, 17, 18, 19, 20, 21, 22, 23, 24, 25, 38, 40], "cmakelex": 10, "cmakelisten": 11, "cmakepars": 12, "cmaketest": 30, "cmakevisitor": 13, "cminx": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 25, 26, 28, 29, 33, 38, 39], "code": 33, "comment": 36, "conf": 38, "config": 3, "configur": 1, "confus": 25, "content": [27, 39], "cov": 25, "coverag": 25, "ctest": 31, "default": 1, "depend": [25, 38], "develop": 27, "direct": 32, "directori": 38, "doc": 38, "document": [4, 7, 25, 26, 27, 30, 31, 32, 33, 34, 35, 37], "document_single_fil": 5, "documentation_typ": 6, "docutil": 25, "domain": 0, "exampl": 38, "except": 8, "featur": 26, "file": [1, 28], "find_python_modul": 18, "from": 38, "function": [15, 32], "get_cmaiz": 19, "get_cmake_test": 20, "get_version_from_git": 21, "how": 28, "index": 38, "initi": 38, "instal": 40, "keyword": 32, "level": 29, "lint": 16, "log": 1, "macro": 34, "main": 9, "manual": 38, "marcokoch": 0, "modern": 0, "modifi": 38, "modul": [15, 35], "offici": 0, "option": [1, 38], "overview": 28, "pars": 28, "parser": [10, 11, 12, 13], "pathspec": 25, "py": 38, "pytest": 25, "python": [15, 25, 40], "python_virt_env": 23, "quickstart": 41, "recommend": 32, "repo": 29, "rest": 32, "rst": 38, "rstwriter": 14, "run": 38, "scikit": 0, "solut": 0, "sourc": 28, "sphinx": [0, 25, 38], "sphinx_rtd_them": 25, "step": 38, "structur": 29, "tabl": [27, 39], "test": [25, 30, 31], "top": 29, "type": 36, "unoffici": 0, "updat": 38, "us": 33, "usag": 42, "variabl": 37, "version": 24, "work": 28, "workflow": 38, "write": 1, "your": 33}})
\ No newline at end of file
diff --git a/usage.html b/usage.html
index 0441fb54..0ebf30e5 100644
--- a/usage.html
+++ b/usage.html
@@ -4,7 +4,7 @@
   
 
   
-  Usage — CMinx v1.1.9 documentation
+  Usage — CMinx v1.1.10 documentation
       
       
 
@@ -15,8 +15,8 @@
   
         
         
-        
-        
+        
+        
         
     
     
@@ -38,7 +38,7 @@
             CMinx
           
               

-                1.1.9
+                1.1.10
               

 

   
@@ -143,7 +143,7 @@ 
Usage
 
   

-    
© Copyright 2023, CMakePP Team.

+    
© Copyright 2024, CMakePP Team.

   

 
   Built with Sphinx using a