diff options
author | Dan Nicholson <dbn@endlessos.org> | 2021-05-20 16:03:56 -0600 |
---|---|---|
committer | Dan Nicholson <dbn@endlessos.org> | 2021-05-21 10:46:49 -0600 |
commit | e19840a25220b399fb213407ec545c8262d1bc39 (patch) | |
tree | 3ccb10d15c8925e0304bb0f77ee500fcabe7a76f /docs/prep-docs.sh | |
parent | 19a306ecefa6f1ef84e7e4c03cd533c30d070fbe (diff) | |
download | ostree-e19840a25220b399fb213407ec545c8262d1bc39.tar.gz |
docs: Copy in API docs and add link
Make a copy of `apidoc/html` to `docs/reference` and then tell Jekyll to
include it verbatim. This will include the gtk-doc API docs on the
static site. A link is added to the main index.
A script is added to do the copy (a symlink won't do) and is setup to
run before Jekyll in the GitHub workflow. Ideally this would be a local
Jekyll plugin to make the process automatic, but the github-pages gem
doesn't allow that.
Diffstat (limited to 'docs/prep-docs.sh')
-rwxr-xr-x | docs/prep-docs.sh | 23 |
1 files changed, 23 insertions, 0 deletions
diff --git a/docs/prep-docs.sh b/docs/prep-docs.sh new file mode 100755 index 00000000..2ae15a74 --- /dev/null +++ b/docs/prep-docs.sh @@ -0,0 +1,23 @@ +#!/bin/sh + +# Prepare docs directory for running jekyll. This would be better as a +# local Jekyll plugin, but those aren't allowed by the github-pages gem. + +set -e + +docsdir=$(dirname "$0") +topdir="$docsdir/.." + +# Make sure the API docs have been generated and copy them to the +# reference directory. +apidocs="$topdir/apidoc/html" +refdir="$docsdir/reference" +if [ ! -d "$apidocs" ]; then + echo "error: API docs $apidocs have not been generated" >&2 + echo "Rebuild with --enable-gtk-doc option" >&2 + exit 1 +fi + +echo "Copying $apidocs to $refdir" +rm -rf "$refdir" +cp -r "$apidocs" "$refdir" |