From 8cb136ee53f14d47885841e6bffa61aa7701ace5 Mon Sep 17 00:00:00 2001 From: manasdk Date: Wed, 6 Jan 2016 17:47:26 -0800 Subject: [PATCH] Update README --- README.md | 11 ++++------- 1 file changed, 4 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index edd0f9fa3..14f99a391 100644 --- a/README.md +++ b/README.md @@ -69,7 +69,7 @@ The docs are build with Sphinx. It's integrated with the main project Makefile. `st2contrib`_ `st2incubator`_ -* The pattern to include an example from `/contrib/examples`: make example file name a reference on github. may say that it is deployed to `/usr/share/doc/st2/examples/`, and auto-include the file: +* The pattern to include an example from `/st2/contrib/examples`: make example file name a reference on github. may say that it is deployed to `/usr/share/doc/st2/examples/`, and auto-include the file: Sample rule: :github_st2:`sample-rule-with-webhook.yaml ` : @@ -90,12 +90,12 @@ pandoc - a super-tool to convert between formats. Sample for markdown conversion To make docs changes, without installing full development environment (e.g., on Mac or Windows: ``` -git clone git@github.com:StackStorm/st2.git -cd st2/docs +git clone git@github.com:StackStorm/st2docs.git +cd st2docs virtualenv .venv . .venv/bin/activate pip install sphinx sphinx-autobuild -sphinx-autobuild -H 0.0.0.0 -b html ./source/ ./build/html +sphinx-autobuild -H 0.0.0.0 -b html ./docs/source/ ./docs/build/html ``` @@ -104,6 +104,3 @@ Edit, enjoy live updates. ## Misc It's ironic that I use Markdown to write about rST tricks. - - -