mgalloy / idldoc

Documenting IDL code
Other
21 stars 13 forks source link

code block not working for me #34

Closed mgalloy closed 11 years ago

mgalloy commented 11 years ago

The following code

;+ 
; This procedure parses echo repeater delay information from the 
; NAD. It is expected to be found in the NAD/targets directory. The 
; file should be of the form:: 
; 
;     DELAY 
;     BUSTER 
;     DD-MMM-YY HH:MM:SS.sss Delay(s) 
;     29-JUL-07 13:49:15 2.500 
;     29-JUL-07 17:13:53 2.500 
;     29-JUL-07 17:50:13 4.000 
; 
; @pre This function requires that the following folder structure be ; in place: NAD/targets/*.txt 
; @author Joe Hood, Akoostix Inc. 
; @todo modify other parsers to use this pattern which requires much 
; less code and change log to use a star_log 
;- 
PRO parse_repeater_delays

Isn't generating the expected code block. In fact the whole top portion ends up looking like one paragraph in the html.

mgalloy commented 11 years ago

Ah, this can be done, but you have to get your styles right: the format style is idldoc and the markup style is rst. So either put:

; docformat = 'idldoc rst'

as the first line of the file to set the styles for just that file or use:

IDL> idldoc, root=root, output=output, format_style='idldoc', markup_style='rst'

to make those the default styles for all your files.