Changes between Version 8 and Version 9 of How to document the quickstart file
- Timestamp:
- 11/19/19 19:14:36 (5 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
How to document the quickstart file
v8 v9 21 21 Write in a friendly, conversational style similar to the way a teacher would talk a class through an example. The QuickStarts for R and GeoServer do this very well. 22 22 23 Write in Restructured Text (RST) format. Docutils provides a good reference for writing in RSTformat [http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html]23 Write in reStructured text (reSt) format. Docutils provides a good reference for writing in reSt format [http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html] 24 24 25 25 Documentation is built using sphinx. You can use a browser-based sphinx editor to preview your work. For example, https://livesphinx.herokuapp.com/