diff --git a/RELEASING.md b/RELEASING.md index 55a6def6e7..44e2dac6a0 100644 --- a/RELEASING.md +++ b/RELEASING.md @@ -44,13 +44,15 @@ The release process calls `towncrier`. It is a Python library that uses the Python utility `pipx`. This utility allows you to call and execute Python modules without installing them as a prerequisite in your system. It works similar to the NodeJS `npx` utility. -On macOS, you can install `pipx` into your system: + +Install {term}`pipx` for your active Python, and ensure it is on your `$PATH`. +Carefully read the console output for further instructions, if needed. ```shell -brew install pipx +python3 -m pip install pipx +pipx ensurepath ``` -Or follow detailed instructions in the `pipx` documentation for [Installation](https://pypa.github.io/pipx/installation/). ## Running the release process diff --git a/docs/source/contributing/branch-policy.md b/docs/source/_inc/_branch-policy.md similarity index 100% rename from docs/source/contributing/branch-policy.md rename to docs/source/_inc/_branch-policy.md diff --git a/docs/source/contributing/install-docker.md b/docs/source/_inc/_install-docker.md similarity index 100% rename from docs/source/contributing/install-docker.md rename to docs/source/_inc/_install-docker.md diff --git a/docs/source/contributing/install-git.md b/docs/source/_inc/_install-git.md similarity index 100% rename from docs/source/contributing/install-git.md rename to docs/source/_inc/_install-git.md diff --git a/docs/source/contributing/install-make.md b/docs/source/_inc/_install-make.md similarity index 100% rename from docs/source/contributing/install-make.md rename to docs/source/_inc/_install-make.md diff --git a/docs/source/contributing/install-nodejs.md b/docs/source/_inc/_install-nodejs.md similarity index 100% rename from docs/source/contributing/install-nodejs.md rename to docs/source/_inc/_install-nodejs.md diff --git a/docs/source/contributing/install-nvm.md b/docs/source/_inc/_install-nvm.md similarity index 100% rename from docs/source/contributing/install-nvm.md rename to docs/source/_inc/_install-nvm.md diff --git a/docs/source/contributing/install-operating-system.md b/docs/source/_inc/_install-operating-system.md similarity index 100% rename from docs/source/contributing/install-operating-system.md rename to docs/source/_inc/_install-operating-system.md diff --git a/docs/source/_static/searchtools.js b/docs/source/_static/searchtools.js deleted file mode 100644 index 23ed8bf5a2..0000000000 --- a/docs/source/_static/searchtools.js +++ /dev/null @@ -1,553 +0,0 @@ -/* - * searchtools.js - * ~~~~~~~~~~~~~~~~ - * - * Sphinx JavaScript utilities for the full-text search. - * - * :copyright: Copyright 2007-2021 by the Sphinx team, see AUTHORS. - * :license: BSD, see LICENSE for details. - * - */ - - -if (!Scorer) { - /** - * Simple result scoring code. - */ - var Scorer = { - // Implement the following function to further tweak the score for each result - // The function takes a result array [filename, title, anchor, descr, score] - // and returns the new score. - /* - score: function(result) { - return result[4]; - }, - */ - - // query matches the full name of an object - objNameMatch: 11, - // or matches in the last dotted part of the object name - objPartialMatch: 6, - // Additive scores depending on the priority of the object - objPrio: {0: 15, // used to be importantResults - 1: 5, // used to be objectResults - 2: -5}, // used to be unimportantResults - // Used when the priority is not in the mapping. - objPrioDefault: 0, - - // query found in title - title: 15, - partialTitle: 7, - // query found in terms - term: 5, - partialTerm: 2 - }; -} - -if (!splitQuery) { - function splitQuery(query) { - return query.split(/\s+/); - } -} - -/** - * Search Module - */ -var Search = { - - _index : null, - _queued_query : null, - _pulse_status : -1, - - htmlToText : function(htmlString) { - var virtualDocument = document.implementation.createHTMLDocument('virtual'); - var htmlElement = $(htmlString, virtualDocument); - htmlElement.find('.headerlink').remove(); - docContent = htmlElement.find('[role=main]')[0]; - if(docContent === undefined) { - console.warn("Content block not found. Sphinx search tries to obtain it " + - "via '[role=main]'. Could you check your theme or template."); - return ""; - } - return docContent.textContent || docContent.innerText; - }, - - init : function() { - var params = $.getQueryParameters(); - if (params.q) { - var query = params.q[0]; - $('input[name="q"]')[0].value = query; - $('input[name="q"]')[1].value = query; - if (params.doc_section) { - var doc_section = params.doc_section[0]; - $('select[name="doc_section"]')[0].value = doc_section; - } - this.performSearch(query, doc_section); - } - }, - - loadIndex : function(url) { - $.ajax({type: "GET", url: url, data: null, - dataType: "script", cache: true, - complete: function(jqxhr, textstatus) { - if (textstatus != "success") { - document.getElementById("searchindexloader").src = url; - } - }}); - }, - - setIndex : function(index) { - var q; - this._index = index; - if ((q = this._queued_query) !== null) { - this._queued_query = null; - Search.query(q); - } - }, - - hasIndex : function() { - return this._index !== null; - }, - - deferQuery : function(query) { - this._queued_query = query; - }, - - stopPulse : function() { - this._pulse_status = 0; - }, - - startPulse : function() { - if (this._pulse_status >= 0) - return; - function pulse() { - var i; - Search._pulse_status = (Search._pulse_status + 1) % 4; - var dotString = ''; - for (i = 0; i < Search._pulse_status; i++) - dotString += '.'; - Search.dots.text(dotString); - if (Search._pulse_status > -1) - window.setTimeout(pulse, 500); - } - pulse(); - }, - - /** - * perform a search for something (or wait until index is loaded) - */ - performSearch : function(query, doc_section) { - // create the required interface elements - this.out = $('#search-results'); - this.title = $('').appendTo(this.out); - this.dots = $('').appendTo(this.title); - this.status = $('

 

').appendTo(this.out); - this.output = $('