Skip to content

Commit

Permalink
Turn off Jekyll for GitHub Pages (apple#145)
Browse files Browse the repository at this point in the history
Problem: Documentation for classes like _ChannelInboundHandler are not accesible via the official API documentation pages

Cause: GitHub treats the gh-pages branch as Jekyll

Solution: Turn off Jekyll by adding a .nojekyll file to the gh-pages branch
  • Loading branch information
Dev1an authored and normanmaurer committed Mar 13, 2018
1 parent b542775 commit a09479c
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions scripts/generate_docs.sh
Original file line number Diff line number Diff line change
Expand Up @@ -89,6 +89,8 @@ if [[ $CI == true ]]; then
git add --all docs
echo '<html><head><meta http-equiv="refresh" content="0; url=docs/current/NIO/index.html" /></head></html>' > index.html
git add index.html
touch .nojekyll
git add .nojekyll
changes=$(git diff-index --name-only HEAD)
if [[ -n "$changes" ]]; then
git commit --author="$GIT_AUTHOR" -m "publish $version docs"
Expand Down

0 comments on commit a09479c

Please sign in to comment.