Repository: flink Updated Branches: refs/heads/master 83102f0ea -> 416ff589e
[FLINK-2433] [docs] Add script to build local documentation on windows This closes #954 Project: http://git-wip-us.apache.org/repos/asf/flink/repo Commit: http://git-wip-us.apache.org/repos/asf/flink/commit/416ff589 Tree: http://git-wip-us.apache.org/repos/asf/flink/tree/416ff589 Diff: http://git-wip-us.apache.org/repos/asf/flink/diff/416ff589 Branch: refs/heads/master Commit: 416ff589e8f7db0d478abdbc602cf089d6603cf3 Parents: 7ee0275 Author: Sachin Goel <sachingoel0...@gmail.com> Authored: Thu Jul 30 09:48:09 2015 +0530 Committer: Stephan Ewen <se...@apache.org> Committed: Mon Aug 3 00:54:36 2015 +0200 ---------------------------------------------------------------------- docs/build_docs.bat | 57 ++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 57 insertions(+) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/flink/blob/416ff589/docs/build_docs.bat ---------------------------------------------------------------------- diff --git a/docs/build_docs.bat b/docs/build_docs.bat new file mode 100644 index 0000000..024b513 --- /dev/null +++ b/docs/build_docs.bat @@ -0,0 +1,57 @@ +::############################################################################### +:: Licensed to the Apache Software Foundation (ASF) under one +:: or more contributor license agreements. See the NOTICE file +:: distributed with this work for additional information +:: regarding copyright ownership. The ASF licenses this file +:: to you under the Apache License, Version 2.0 (the +:: "License"); you may not use this file except in compliance +:: with the License. You may obtain a copy of the License at +:: +:: http://www.apache.org/licenses/LICENSE-2.0 +:: +:: Unless required by applicable law or agreed to in writing, software +:: distributed under the License is distributed on an "AS IS" BASIS, +:: WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +:: See the License for the specific language governing permissions and +:: limitations under the License. +::############################################################################### + +@echo off +:start +call jekyll -version >nul 2>&1 +if "%errorlevel%"=="0" goto check_redcarpet +echo ERROR: Could not find jekyll. +echo Please install with 'gem install jekyll' (see http://jekyllrb.com). +exit /b 1 + +:check_redcarpet +call redcarpet -version >nul 2>&1 +if "%errorlevel%"=="0" goto check_pygments +echo WARN: Could not find redcarpet. +echo Please install with 'gem install redcarpet' (see https://github.com/vmg/redcarpet). +echo Redcarpet is needed for Markdown parsing and table of contents generation. +goto check_pygments + +:check_pygments +call python -c "import pygments" >nul 2>&1 +if "%errorlevel%"=="0" goto execute +echo WARN: Could not find pygments. +echo Please install with 'sudo easy_install Pygments' (requires Python; see http://pygments.org). +echo Pygments is needed for syntax highlighting of the code examples. +goto execute + +:execute +SET "DOCS_SRC=%cd%" +SET "DOCS_DST=%DOCS_SRC%\target" + +::default jekyll command is to just build site +::if flag p is set, start the webserver too. +IF "%1"=="" GOTO :build +IF "%1"=="-p" GOTO :serve +GOTO :build + +:build +jekyll build --source %DOCS_SRC% --destination %DOCS_DST% + +:serve +jekyll serve --baseurl "" --watch --source %DOCS_SRC% --destination %DOCS_DST%
