Skip to content

Commit

Permalink
readthedocs: add sphinx-finished.sh
Browse files Browse the repository at this point in the history
A script to fix index.html is added.

Signed-off-by: Juergen Repp <juergen_repp@web.de>
  • Loading branch information
JuergenReppSIT committed Dec 5, 2024
1 parent 439cbf8 commit ae1a5fb
Showing 1 changed file with 23 additions and 0 deletions.
23 changes: 23 additions & 0 deletions sphinx/sphinx-finished.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
#!/usr/bin/env bash
# SPDX-License-Identifier: BSD-2

#
# This script is configured to run as part of the sphinx build
# through API events registered in conf.py.
# This script runs on event build-finished.
#
# This would be better served by handling the events
# html-collect-page --> for add .nojekyll
# html-page-context --> for fixing the span's done with sed.
#
# For the case of time, we just left this script as is and run it as a
# post sphinx build command event :-p
#

set -eo pipefail

find "${SPHINX_OUTDIR}" -name \*.html -exec \
sed -i 's/\&amp;\#/\&\#/g' {} \;
touch "${SPHINX_OUTDIR}"/.nojekyll

exit 0

0 comments on commit ae1a5fb

Please sign in to comment.