source: specdomain/trunk/src/specdomain/doc/howto-markup.rst @ 1020

Last change on this file since 1020 was 1020, checked in by jemian, 10 years ago

refs #8, show how to markup a SPEC Macro File

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision URL Header
File size: 726 bytes
Line 
1.. $Id: howto-markup.rst 1020 2012-07-15 22:29:27Z jemian $
2
3==========================================================
4How to Markup a SPEC Macro File
5==========================================================
6
7#. start with SPEC macro file that is not marked up
8#. create a Sphinx documentation project
9#. apply markup
10#. test
11
12Basic SPEC Macro file
13==============================
14
15--tba--
16
17
18Create a Sphinx Project
19==============================
20
21.. tip:: Use an *in-source* configuration
22.. make a reference to in-source
23
24--tba--
25
26Apply Markup
27==============================
28
29#. normal SPEC comments
30#. extended comments (docstrings)
31   #. global docstring
32   #. macro docstring
33   #. others are ignored by Sphinx
34#. descriptive comments
35
36--tba--
37
38Test
39-----------
40
41--tba--
Note: See TracBrowser for help on using the repository browser.