Skip to content

Commit 9d659a4

Browse files
superstessuperstes
committed
update docs-infra
1 parent 468bafd commit 9d659a4

File tree

7 files changed

+159
-7
lines changed

7 files changed

+159
-7
lines changed

‎.gitignore

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,4 +7,5 @@ __pychache__.py
77
**/aw*.db.*bak*
88
**/aw*.db-shm
99
**/aw*.db-wal
10-
VERSION
10+
VERSION
11+
docs/build/

‎docs/html_infra.sh

Lines changed: 76 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
#!/bin/bash
2+
3+
if [ -z "$1" ]
4+
then
5+
DEST_DIR='build'
6+
else
7+
DEST_DIR="$1"
8+
fi
9+
10+
set -euo pipefail
11+
12+
function log() {
13+
msg="$1"
14+
echo ''
15+
echo "### ${msg} ###"
16+
echo ''
17+
}
18+
19+
cd "$(dirname "$0")"
20+
21+
SRC_DIR="$(pwd)"
22+
23+
TS="$(date +%s)"
24+
TMP_DIR="/tmp/${TS}"
25+
mkdir -p "${TMP_DIR}"
26+
27+
VENV_BIN='/tmp/.ag-docs-venv/bin/activate'
28+
if [ -f "$VENV_BIN" ]
29+
then
30+
source "$VENV_BIN"
31+
fi
32+
33+
log 'BUILDING DOCS'
34+
export PYTHONWARNINGS='ignore'
35+
sphinx-build -b html source/ "${TMP_DIR}/" >/dev/null
36+
37+
log 'PATCHING METADATA'
38+
cp "${SRC_DIR}/meta/"* "${TMP_DIR}/"
39+
40+
HTML_META_SRC="<meta charset=\"utf-8\" />"
41+
HTML_META="${HTML_META_SRC}<meta http-equiv=\"Content-Security-Policy\" content=\"default-src 'self'; img-src 'self' https://files.oxl.at; style-src 'self' https://files.oxl.at 'unsafe-inline'; script-src 'self' https://files.oxl.at 'unsafe-inline' 'unsafe-eval'; connect-src 'self';\">"
42+
HTML_META="${HTML_META}<link rel=\"icon\" type=\"image/webp\" href=\"https://files.oxl.at/img/oxl3_sm.webp\">"
43+
HTML_META_EN="${HTML_META}" # <link rel=\"alternate\" href=\"https://docs.o-x-l.at\" hreflang=\"de\">
44+
# HTML_LOGO_LINK_SRC='href=".*Go to homepage"'
45+
# HTML_LOGO_LINK_EN='href="https://www.o-x-l.com" class="oxl-nav-logo" title="OXL IT Services Website"'
46+
HTML_TITLE_BAD_EN='AnsibleGuy WebUI documentation'
47+
HTML_TITLE_OK='Simple Ansible WebUI'
48+
HTML_LANG_NONE='<html'
49+
HTML_LANG_EN='html lang="en"'
50+
51+
cd "${TMP_DIR}/"
52+
53+
sed -i "s|$HTML_META_SRC|$HTML_META_EN|g" *.html
54+
sed -i "s|$HTML_META_SRC|$HTML_META_EN|g" */*.html
55+
# sed -i "s|$HTML_LOGO_LINK_SRC|$HTML_LOGO_LINK_EN|g" *.html
56+
# sed -i "s|$HTML_LOGO_LINK_SRC|$HTML_LOGO_LINK_EN|g" */*.html
57+
sed -i "s|$HTML_LANG_NONE|<$HTML_LANG_EN|g" *.html
58+
sed -i "s|$HTML_LANG_NONE|<$HTML_LANG_EN|g" */*.html
59+
sed -i "s|$HTML_TITLE_BAD_EN|$HTML_TITLE_OK|g" *.html
60+
sed -i "s|$HTML_TITLE_BAD_EN|$HTML_TITLE_OK|g" */*.html
61+
62+
log 'ACTIVATING'
63+
cd "$SRC_DIR"
64+
if [ -d "$DEST_DIR" ]
65+
then
66+
rm -r "$DEST_DIR"
67+
fi
68+
mkdir -p "${DEST_DIR}/"
69+
70+
mv "${TMP_DIR}/"* "${DEST_DIR}/"
71+
72+
touch "${DEST_DIR}/${TS}"
73+
74+
rm -rf "$TMP_DIR"
75+
76+
log 'FINISHED'

‎docs/meta/robots.txt

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
User-agent: anthropic-ai
2+
Disallow: /
3+
4+
User-agent: Claude-Web
5+
Disallow: /
6+
7+
User-agent: ClaudeBot
8+
Disallow: /
9+
10+
User-agent: PerplexityBot
11+
Disallow: /
12+
13+
User-agent: CCBot
14+
Disallow: /
15+
16+
User-agent: Google-Extended
17+
Disallow: /
18+
19+
User-agent: GPTBot
20+
Disallow: /
21+
22+
User-agent: ChatGPT-User
23+
Disallow: /
24+
25+
User-agent: *
26+
Disallow:
27+
Sitemap: sitemap.xml

‎docs/meta/sitemap.xml

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
3+
<url><loc>https://webui.ansibleguy.net/en/latest/</loc></url>
4+
5+
<url><loc>https://webui.ansibleguy.net/en/latest/usage/1_intro.html</loc></url>
6+
<url><loc>https://webui.ansibleguy.net/en/latest/usage/2_install.html</loc></url>
7+
<url><loc>https://webui.ansibleguy.net/en/latest/usage/3_run.html</loc></url>
8+
<url><loc>https://webui.ansibleguy.net/en/latest/usage/4_config.html</loc></url>
9+
10+
<url><loc>https://webui.ansibleguy.net/en/latest/usage/alerts.html</loc></url>
11+
<url><loc>https://webui.ansibleguy.net/en/latest/usage/api.html</loc></url>
12+
<url><loc>https://webui.ansibleguy.net/en/latest/usage/authentication.html</loc></url>
13+
<url><loc>https://webui.ansibleguy.net/en/latest/usage/backup.html</loc></url>
14+
<url><loc>https://webui.ansibleguy.net/en/latest/usage/credentials.html</loc></url>
15+
<url><loc>https://webui.ansibleguy.net/en/latest/usage/development.html</loc></url>
16+
<url><loc>https://webui.ansibleguy.net/en/latest/usage/docker.html</loc></url>
17+
<url><loc>https://webui.ansibleguy.net/en/latest/usage/integrations.html</loc></url>
18+
<url><loc>https://webui.ansibleguy.net/en/latest/usage/jobs.html</loc></url>
19+
<url><loc>https://webui.ansibleguy.net/en/latest/usage/privileges.html</loc></url>
20+
<url><loc>https://webui.ansibleguy.net/en/latest/usage/repositories.html</loc></url>
21+
<url><loc>https://webui.ansibleguy.net/en/latest/usage/security.html</loc></url>
22+
<url><loc>https://webui.ansibleguy.net/en/latest/usage/troubleshooting.html</loc></url>
23+
</urlset>

‎docs/source/_static/img/logo.svg

Lines changed: 13 additions & 0 deletions
Loading

0 commit comments

Comments
 (0)