mirror of
https://github.com/ostreedev/ostree.git
synced 2024-12-22 17:35:55 +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.
32 lines
1.1 KiB
Markdown
32 lines
1.1 KiB
Markdown
This documentation is written in [Jekyll](https://jekyllrb.com/) format
|
|
to be published on [GitHub Pages](https://pages.github.com/). The
|
|
rendered HTML will be automatically built and published, but you can
|
|
also use Jekyll locally to test changes.
|
|
|
|
First you need to install [Ruby](https://www.ruby-lang.org/en/) and
|
|
[RubyGems](https://rubygems.org/) to get Jekyll and the other gem
|
|
dependencies. This is easiest using the distro's packages. On RedHat
|
|
systems this is `rubygems` and on Debian systems this is
|
|
`ruby-rubygems`.
|
|
|
|
Next [Bundler](https://bundler.io/) is needed to install the gems using
|
|
the provided [Gemfile](Gemfile). You can do this by running `gem install
|
|
bundler` or using distro packages. On RedHat systems this is
|
|
`rubygem-bundler` and on Debian systems this is `ruby-bundler`.
|
|
|
|
Now you can prepare the Jekyll environment. Change to this directory and
|
|
run:
|
|
|
|
```
|
|
bundle config set --local path vendor/bundle
|
|
bundle install
|
|
```
|
|
|
|
Finally, run the `prep-docs.sh` script and then render and serve the
|
|
site locally with Jekyll:
|
|
|
|
```
|
|
./prep-docs.sh
|
|
bundle exec jekyll serve
|
|
```
|