Changes between Version 6 and Version 7 of How to document the quickstart file

Timestamp:

11/18/19 20:16:50 (5 years ago)

Author:

flicstar

Comment:

Some further additions to the page

How to document the quickstart file

@@ -26 +26 @@
 Source documentation is written in RST wiki format and is built using sphinx. Docutils provides a good reference for writing in RST format [http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html]
 
-Use Sphinx inline markup such as :guilabel: for buttons and field names; and :menuselection: for selecting menu items. 
+You can use a browser-based sphinx editor to preview your work. For example, https://livesphinx.herokuapp.com/
 
 **Section headings**
@@ -48 +48 @@
          :scale: 70 %
 
+Use Sphinx inline markup such as :guilabel: for buttons and field names; and :menuselection: for selecting menu items. 
 
 The following is for a code block
@@ -149 +150 @@
 
 .. contents:: Contents
+   :local:
 
   
@@ -185 +187 @@
 #. Nulla posuere sollicitudin aliquam ultrices sagittis. Ultrices dui sapien eget mi proin sed libero. Tellus id interdum velit laoreet id donec ultrices. 
 Nunc sed velit dignissim sodales. Elit ut aliquam purus sit amet luctus. 
+  * Tortor dignissim 
+  * convallis aenean
+  * turpis egestas integer 
 #. Proin fermentum leo vel orci porta. Fermentum odio eu feugiat pretium nibh. Nunc mi ipsum faucibus vitae aliquet. Ac ut consequat semper viverra. Velit ut tortor pretium viverra suspendisse. Mauris augue neque gravida in. 
 
 Eleifend quam adipiscing vitae proin sagittis. Risus viverra adipiscing at in tellus integer feugiat scelerisque variu
+
+.. tip:: Eget est lorem ipsum dolor sit amet. Nibh nisl condimentum id venenatis.