How to view these docs
How to edit these docs
Run the following.
cd ~/projects/sandstorm virtualenv tmp/docs-virtualenv tmp/docs-virtualenv/bin/pip install mkdocs tmp/docs-virtualenv/bin/pip install markdown-inline-graphviz # Get an unreleased version of mkdocs because we need the readthedocs theme 'Searching...' fix tmp/docs-virtualenv/bin/pip install --upgrade git+https://github.com/mkdocs/mkdocs.git#egg=mkdocs # Get "dot" so we can render inline dot/graphviz sudo apt-get install -y graphviz tmp/docs-virtualenv/bin/mkdocs serve
Then visit http://localhost:8000/
How to add images to the docs
In quick bullet points:
You can add images to the docs.
Look for examples of Markdown image syntax. For example,
Set the IMG SRC to point at whatever URL you like, preferably a Sandstorm static publishing URL that you own.
When your pull request gets merged, @paulproteus will copy them to a Davros grain he controls on oasis.sandstorm.io.
The reason for all this is that images can bloat a git repository a lot, so for now, we don't store the images the main Sandstorm git repo.
How to deploy to docs.sandstorm.io
Ask Asheesh to share a particular GitWeb Pages grain with you. It's located on https://alpha.sandstorm.io/.
git cloneof that repository into a directory, like:
git clone https://email@example.com/ tmp/sandstorm-docs
generate.shto re-generate the docs, then commit them to this git repo.
PATH=$PATH:$PWD/tmp/docs-virtualenv/bin bash docs/generate.sh -d tmp/sandstorm-docs
-pflag to actually push them to the live site.
PATH=$PATH:$PWD/tmp/docs-virtualenv/bin bash docs/generate.sh -d tmp/sandstorm-docs -p