Skip to content

Commit

Permalink
Merge pull request #121 from ansibleguy/docs-infra
Browse files Browse the repository at this point in the history
Docs infra
  • Loading branch information
ansibleguy authored Dec 7, 2024
2 parents 00f810a + 9020d29 commit 9574727
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 4 deletions.
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@
[![Functional Test Status](https://badges.ansibleguy.net/opnsense.collection.test.svg)](https://github.com/ansibleguy/collection_opnsense/blob/latest/scripts/test.sh)
[![Lint Test Status](https://badges.ansibleguy.net/opnsense.collection.lint.svg)](https://github.com/ansibleguy/collection_opnsense/blob/latest/scripts/lint.sh)
[![Unit Test Status](https://github.com/ansibleguy/collection_opnsense/actions/workflows/unit_test.yml/badge.svg)](https://github.com/ansibleguy/collection_opnsense/actions/workflows/unit_test.yml)
[![Docs](https://readthedocs.org/projects/opnsense_ansible/badge/?version=latest&style=flat)](https://opnsense.ansibleguy.net)
[![Ansible Galaxy](https://badges.ansibleguy.net/galaxy.badge.svg)](https://galaxy.ansible.com/ui/repo/published/ansibleguy/opnsense)

Functional Test Logs: [Short](https://badges.ansibleguy.net/log/collection_opnsense_test_short.log), [Full](https://badges.ansibleguy.net/log/collection_opnsense_test.log)
Expand Down Expand Up @@ -38,6 +37,8 @@ ansible-galaxy collection install ansibleguy.opnsense

See: [Docs](https://opnsense.ansibleguy.net)

[![Docs Uptime](https://status.oxl.at/api/v1/endpoints/4--ansibleguy_ansible-collection---opnsense-documentation/uptimes/7d/badge.svg)](https://status.oxl.at/endpoints/4--ansibleguy_ansible-collection---opnsense-documentation)

If you DO NOT want to use Ansible - [this fork](https://github.com/O-X-L/opnsense-api-client) provides you with a raw Python3 interface.

----
Expand Down
5 changes: 3 additions & 2 deletions docs/html_infra.sh
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,8 @@ TS="$(date +%s)"
TMP_DIR="/tmp/${TS}"
mkdir -p "${TMP_DIR}"

VENV_BIN='/tmp/.ag-opnsense-venv/bin/activate'
VENV_BIN='/tmp/.ag-docs-venv/bin/activate'

if [ -f "$VENV_BIN" ]
then
source "$VENV_BIN"
Expand All @@ -43,7 +44,7 @@ HTML_META="${HTML_META}<link rel=\"icon\" type=\"image/webp\" href=\"https://fil
HTML_META_EN="${HTML_META}" # <link rel=\"alternate\" href=\"https://docs.o-x-l.at\" hreflang=\"de\">
# HTML_LOGO_LINK_SRC='href=".*Go to homepage"'
# HTML_LOGO_LINK_EN='href="https://www.o-x-l.com" class="oxl-nav-logo" title="OXL IT Services Website"'
HTML_TITLE_BAD_EN='Ansible Collection OPNSense documentation'
HTML_TITLE_BAD_EN='Ansible Collection - OPNSense documentation'
HTML_TITLE_OK='OPNSense Ansible Collection'
HTML_LANG_NONE='<html'
HTML_LANG_EN='html lang="en"'
Expand Down
2 changes: 1 addition & 1 deletion docs/venv.sh
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ set -euo pipefail

cd "$(dirname "$0")"

VENV_PATH='/tmp/.ag-opnsense-venv'
VENV_PATH='/tmp/.ag-docs-venv'

python3 -m virtualenv "$VENV_PATH"
source "${VENV_PATH}/bin/activate"
Expand Down

0 comments on commit 9574727

Please sign in to comment.