mirror of
https://github.com/ostreedev/ostree.git
synced 2025-01-11 09:18:20 +03:00
e19840a252
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.
55 lines
1.3 KiB
YAML
55 lines
1.3 KiB
YAML
title: ostreedev/ostree
|
|
description: ostree documentation
|
|
baseurl: "/ostree"
|
|
url: "https://ostreedev.github.io"
|
|
# Comment above and use below for local development
|
|
# url: "http://localhost:4000"
|
|
permalink: /:title/
|
|
markdown: kramdown
|
|
|
|
# Exclude the README and the bundler files that would normally be
|
|
# ignored by default.
|
|
exclude:
|
|
- README.md
|
|
- Gemfile
|
|
- Gemfile.lock
|
|
- prep-docs.sh
|
|
- vendor/
|
|
|
|
# This is a copy of the apidoc/html directory. Run prep-docs.sh before
|
|
# jekyll to put it in place.
|
|
include: [reference]
|
|
|
|
remote_theme: coreos/just-the-docs
|
|
plugins:
|
|
- jekyll-remote-theme
|
|
|
|
color_scheme: coreos
|
|
|
|
# Aux links for the upper right navigation
|
|
aux_links:
|
|
"OSTree on GitHub":
|
|
- "https://github.com/ostreedev/ostree"
|
|
|
|
footer_content: "Copyright © <a href=\"https://www.redhat.com\">Red Hat, Inc.</a> and <a href=\"https://github.com/ostreedev\">others</a>."
|
|
|
|
# Footer last edited timestamp
|
|
last_edit_timestamp: true
|
|
last_edit_time_format: "%b %e %Y at %I:%M %p"
|
|
|
|
# Footer "Edit this page on GitHub" link text
|
|
gh_edit_link: true
|
|
gh_edit_link_text: "Edit this page on GitHub"
|
|
gh_edit_repository: "https://github.com/ostreedev/ostree"
|
|
gh_edit_branch: "main"
|
|
gh_edit_source: docs
|
|
gh_edit_view_mode: "tree"
|
|
|
|
compress_html:
|
|
clippings: all
|
|
comments: all
|
|
endings: all
|
|
startings: []
|
|
blanklines: false
|
|
profile: false
|