mirror of
https://github.com/elastic/logstash.git
synced 2025-04-21 13:18:16 -04:00
**Motivation**: We have decided to rewrite the documentation generator to add more features to our documentation and to fix some outstanding bugs. This PR addresses the following problem: - Hard to add new features to the code base. - The code was tied with Logstash. - No easy way to publish the doc for a single plugin - The plugin author was not able to test their documentation changes - The reported errors were hard to understand. - No easy way to automate it. - the minimal requirement on base classes. Fixes #5720
15 lines
504 B
Bash
Executable file
15 lines
504 B
Bash
Executable file
#!/usr/bin/env bash
|
|
set -e
|
|
|
|
# Since we are using the system jruby, we need to make sure our jvm process
|
|
# uses at least 1g of memory, If we don't do this we can get OOM issues when
|
|
# installing gems. See https://github.com/elastic/logstash/issues/5179
|
|
export JRUBY_OPTS="-J-Xmx1g"
|
|
|
|
mkdir -p build/docs
|
|
rm -rf build/docs/*
|
|
|
|
grep -q -F "logstash-docgen" Gemfile || echo 'gem "logstash-docgen", :path => "./tools/logstash-docgen"' >> Gemfile
|
|
rake bootstrap
|
|
rake test:install-core
|
|
rake docs:generate-plugins
|