rojo-rbx/rojo
1
0
Fork 1
mirror of https://github.com/rojo-rbx/rojo.git synced 2026-04-23 22:25:26 +00:00
Code Issues Packages Projects Releases Wiki Activity

Stop building documentation root, only version-specific docs

Browse Source
This commit is contained in:
Lucien Greathouse
2019-01-10 11:15:11 -08:00
parent 9ac001bd3e
commit d52ecaa050
3 changed files with 7 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
README.md
View File

@@ -11,8 +11,8 @@
<a href="https://crates.io/crates/rojo"> <a href="https://crates.io/crates/rojo">
<img src="https://img.shields.io/crates/v/rojo.svg?label=version" alt="Latest server version" /> <img src="https://img.shields.io/crates/v/rojo.svg?label=version" alt="Latest server version" />
</a> </a>
<a href="https://lpghatguy.github.io/rojo"> <a href="https://lpghatguy.github.io/rojo/0.4.x">
<img src="https://img.shields.io/badge/documentation-website-brightgreen.svg" alt="Rojo Documentation" /> <img src="https://img.shields.io/badge/documentation-0.4.x-brightgreen.svg" alt="Rojo Documentation" />
</a> </a>
</div> </div>
@@ -38,7 +38,7 @@ Soon, Rojo will be able to:
* Sync `rbxmx` models between the filesystem and Roblox Studio * Sync `rbxmx` models between the filesystem and Roblox Studio
* Package projects into `rbxmx` files from the command line * Package projects into `rbxmx` files from the command line
## [Documentation](https://lpghatguy.github.io/rojo) ## [Documentation](https://lpghatguy.github.io/rojo/0.4.x)
You can also view the documentation by browsing the [docs](https://github.com/LPGhatguy/rojo/tree/master/docs) folder of the repository, but because it uses a number of Markdown extensions, it may not be very readable. You can also view the documentation by browsing the [docs](https://github.com/LPGhatguy/rojo/tree/master/docs) folder of the repository, but because it uses a number of Markdown extensions, it may not be very readable.
## Inspiration and Alternatives ## Inspiration and Alternatives

2
docs/index.md
View File

@@ -1,6 +1,6 @@
This is the documentation home for Rojo. This is the documentation home for Rojo.
Other versions of these docs: Available versions of these docs:
* [0.5.x](https://lpghatguy.github.io/rojo/0.5.x) * [0.5.x](https://lpghatguy.github.io/rojo/0.5.x)
* [0.4.x](https://lpghatguy.github.io/rojo/0.4.x) * [0.4.x](https://lpghatguy.github.io/rojo/0.4.x)

7
generate-docs
View File

@@ -3,7 +3,8 @@
# Kludged documentation generator to support multiple versions. # Kludged documentation generator to support multiple versions.
# Make sure the `site` folder is a checkout of this repository's `gh-pages` # Make sure the `site` folder is a checkout of this repository's `gh-pages`
# branch. # branch.
# To use, run `generate-docs` in the root of the repository. # To use, copy this file to `generate-docs.run` so that Git will leave it alone,
# then run `generate-docs.run` in the root of the repository.
set -e set -e
@@ -12,12 +13,10 @@ CURRENT_BRANCH=$(git rev-parse --abbrev-ref HEAD)
echo "Building 0.4.x" echo "Building 0.4.x"
git checkout v0.4.x git checkout v0.4.x
git pull git pull
mkdocs build --site-dir site
mkdocs build --site-dir site/0.4.x mkdocs build --site-dir site/0.4.x
git checkout master
echo "Building master" echo "Building master"
git checkout master
mkdocs build --site-dir site/master mkdocs build --site-dir site/master
echo "Building 0.5.x" echo "Building 0.5.x"