Multiple versions of the docs

This commit is contained in:
Lucien Greathouse
2019-01-09 23:14:59 -08:00
parent 54b8a1aea5
commit 95866d0f2e
2 changed files with 31 additions and 0 deletions

View File

@@ -1,5 +1,11 @@
This is the documentation home for Rojo.
Other versions of these docs:
* [0.5.x](https://lpghatguy.github.io/rojo/0.5.x)
* [0.4.x](https://lpghatguy.github.io/rojo/0.4.x)
* [`master` branch](https://lpghatguy.github.io/rojo/master)
**Rojo** is a flexible multi-tool designed for creating robust Roblox projects.
This documentation is a continual work in progress. If you find any issues, please file an issue on [Rojo's issue tracker](https://github.com/LPGhatguy/rojo/issues)!

25
generate-docs Normal file
View File

@@ -0,0 +1,25 @@
#!/bin/sh
# Kludged documentation generator to support multiple versions.
# Make sure the `site` folder is a checkout of this repository's `gh-pages`
# branch.
# To use, run `generate-docs` in the root of the repository.
set -e
CURRENT_BRANCH=$(git rev-parse --abbrev-ref HEAD)
echo "Building 0.4.x"
git checkout v0.4.x
mkdocs build --site-dir site
mkdocs build --site-dir site/0.4.x
git checkout master
echo "Building master"
mkdocs build --site-dir site/master
echo "Building 0.5.x"
mkdocs build --site-dir site/0.5.x
git checkout "$CURRENT_BRANCH"