xref: /petsc/doc/manualpages/doctext/myst.def (revision 53673ba54f5aaba04b9d49ab22cf56c7a7461fe9)
1#
2# These are the definitions for doc2lt and doctext MyST (Markdown) output
3#
4
5# There are some HTML tags below. These should work with Markdown, but it would
6# be cleaner to use MyST-native syntax where possible.
7
8# Note that the definition lists require the MyST "deflist" extension to be active
9
10key                %n`%1`
11synopsis           %n%1
12definition         %n**%1**%n
13
14# I want to use
15#section            %n%n#### %1%n
16# but it gives the warning message: WARNING: Non-consecutive header level increase; H1 to H4
17# and uses H2 anyways. So we end up with huge headings that take up too much space on the page.
18# Changing the first # at the top of the page to ## also doesn't help, it ALWAYS starts with H1.
19# Question posted on stackoverflow but likely impossible since # is used to structure the
20# document, not just as size indicator
21
22section            %n%n## %1%n
23s_synopsis         %n%n## Synopsis%n```%n
24e_synopsis         %n```%n
25em_dash
26eof
27bof
28bop
29eop
30
31s_arg_list         %n%n
32s_arg_inlist       - ***
33e_arg_inlist       -***
34s_defn_inlist      \
35e_defn_inlist      %n
36e_arg_list         %n%n
37
38s_arg              - ***
39e_arg              -***
40s_defn             \
41e_defn             %n
42
43s_doctext_verbatim %n```none%n
44e_doctext_verbatim %n```%n
45s_caption          <CENTER><B>
46e_caption          </B></CENTER>
47picture            ![%1](%1)
48
49end_par            %n%n
50location           **Location:**<A HREF="PETSC_DOC_OUT_ROOT_PLACEHOLDER/%1#%rq0">%1</A>%n
51
52mantitle           # %1%n
53mantitlemany       %n%n# %1%n
54bofmanyend
55anchor             <a name="%1"></a>
56