summaryrefslogtreecommitdiff
path: root/manage
diff options
context:
space:
mode:
authorMarkus Heiser <markus.heiser@darmarit.de>2022-03-12 10:18:08 +0100
committerMarkus Heiser <markus.heiser@darmarit.de>2022-03-12 11:36:31 +0100
commitb1912607ae9783d6ccf648bd7706a64eca5bedb9 (patch)
treea27ada16192c85d3bd7fa25714a113e2d621433f /manage
parentbb71ebc3945b8e345bebe45a7d393afba6366ab9 (diff)
[mod] replace /help by /info pages and include pages in project docs
This patch implements a bolierplate to share content from info-pages of the SearXNG instance (URL /info) with the project documentation (path /docs/user). The info pages are using Markdown (CommonMark), to include them in the project documentation (reST) the myst-parser [1] is used in the Sphinx-doc build chain. If base_url is known (defined in settings.yml) links to the instance are also inserted into the project documentation:: searxng_extra/docs_prebuild [1] https://www.sphinx-doc.org/en/master/usage/markdown.html Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
Diffstat (limited to 'manage')
-rwxr-xr-xmanage1
1 files changed, 1 insertions, 0 deletions
diff --git a/manage b/manage
index 678f6401..e70b7f4d 100755
--- a/manage
+++ b/manage
@@ -419,6 +419,7 @@ docs.prebuild() {
./utils/searx.sh doc | cat > "${DOCS_BUILD}/includes/searx.rst"
./utils/filtron.sh doc | cat > "${DOCS_BUILD}/includes/filtron.rst"
./utils/morty.sh doc | cat > "${DOCS_BUILD}/includes/morty.rst"
+ pyenv.cmd searxng_extra/docs_prebuild
)
dump_return $?
}