diff --git a/docs/README.md b/docs/README.md index 7a5ee3f8..fce7f238 100644 --- a/docs/README.md +++ b/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