summaryrefslogtreecommitdiff
path: root/docs/README.md
diff options
context:
space:
mode:
authorDan Nicholson <dbn@endlessos.org>2021-05-20 16:03:56 -0600
committerDan Nicholson <dbn@endlessos.org>2021-05-21 10:46:49 -0600
commite19840a25220b399fb213407ec545c8262d1bc39 (patch)
tree3ccb10d15c8925e0304bb0f77ee500fcabe7a76f /docs/README.md
parent19a306ecefa6f1ef84e7e4c03cd533c30d070fbe (diff)
downloadostree-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/README.md')
-rw-r--r--docs/README.md5
1 files changed, 4 insertions, 1 deletions
diff --git a/docs/README.md b/docs/README.md
index 7963b04e..f1f89ecb 100644
--- a/docs/README.md
+++ b/docs/README.md
@@ -22,7 +22,10 @@ bundle config set --local path vendor/bundle
bundle install
```
-Finally, render and serve the site locally with Jekyll:
+Finally, run the `prep-docs.sh` script and then render and serve the
+site locally with Jekyll:
+
```
+./prep-docs.sh
bundle exec jekyll serve
```