From c6d0d33e877d088987af4bf5059efbb6387549f3 Mon Sep 17 00:00:00 2001 From: Thatcher Peskens Date: Mon, 8 Apr 2013 20:10:47 -0700 Subject: [PATCH] Added code and color for 'note' and updated the hello world note. Upstream-commit: f4399fe4034973db9a45795593281d284f78227e Component: cli --- components/cli/docs/README.md | 34 +++++++++++++++++++++++++++++++++- 1 file changed, 33 insertions(+), 1 deletion(-) diff --git a/components/cli/docs/README.md b/components/cli/docs/README.md index 7a5ee3f8a9..fce7f238fb 100644 --- a/components/cli/docs/README.md +++ b/components/cli/docs/README.md @@ -39,4 +39,36 @@ Notes * The index.html and gettingstarted.html files are copied from the source dir to the output dir without modification. So changes to those pages should be made directly in html * For the template the css is compiled from less. When changes are needed they can be compiled using -lessc ``lessc main.less`` or watched using watch-lessc ``watch-lessc -i main.less -o main.css`` \ No newline at end of file +lessc ``lessc main.less`` or watched using watch-lessc ``watch-lessc -i main.less -o main.css`` + + +Guides on using sphinx +---------------------- +* To make links to certain pages create a link target like so: + + ``` + .. _hello_world: + + Hello world + =========== + + This is.. (etc.) + ``` + + The ``_hello_world:`` will make it possible to link to this position (page and marker) from all other pages. + +* Notes, warnings and alarms + + ``` + # a note (use when something is important) + .. note:: + + # a warning (orange) + .. warning:: + + # danger (red, use sparsely) + .. danger:: + +* Code examples + + Start without $, so it's easy to copy and paste. \ No newline at end of file