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


Ignore:
Timestamp:
18 Nov 2019 20:16:50 (12 months ago)
Author:
flicstar
Comment:

Some further additions to the page

Legend:

Unmodified
Added
Removed
Modified
  • How to document the quickstart file

    v6 v7  
    2626Source 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]
    2727
    28 Use Sphinx inline markup such as :guilabel: for buttons and field names; and :menuselection: for selecting menu items.
     28You can use a browser-based sphinx editor to preview your work. For example, https://livesphinx.herokuapp.com/
    2929
    3030**Section headings**
     
    4848         :scale: 70 %
    4949
     50Use Sphinx inline markup such as :guilabel: for buttons and field names; and :menuselection: for selecting menu items.
    5051
    5152The following is for a code block
     
    149150
    150151.. contents:: Contents
     152   :local:
    151153
    152154 
     
    185187#. Nulla posuere sollicitudin aliquam ultrices sagittis. Ultrices dui sapien eget mi proin sed libero. Tellus id interdum velit laoreet id donec ultrices.
    186188Nunc sed velit dignissim sodales. Elit ut aliquam purus sit amet luctus.
     189  * Tortor dignissim
     190  * convallis aenean
     191  * turpis egestas integer
    187192#. 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.
    188193
    189194Eleifend quam adipiscing vitae proin sagittis. Risus viverra adipiscing at in tellus integer feugiat scelerisque variu
     195
     196.. tip:: Eget est lorem ipsum dolor sit amet. Nibh nisl condimentum id venenatis.
    190197
    191198