Register
Login
Resources
Docs Blog Datasets Glossary Case Studies Tutorials & Webinars
Product
Data Engine LLMs Platform Enterprise
Pricing Explore
Connect to our Discord channel

rst-cheatsheet.rst_ 2.2 KB

You have to be logged in to leave a comment. Sign In
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
  1. Formatting text
  2. ===============
  3. Paragraphs are simply chunks of text separated by one or
  4. more blank lines.
  5. It's simple to use inline markup to have *italic text*,
  6. **bold text**, and ``inline source codes``.
  7. It's a little complicated to write a GMT option.
  8. You need to use backslash + pipe to have a pipe (|) and
  9. backslash + whitespace to separate inline markups.
  10. **-A**\ *value*\ [**+w**\ *pen*][**+a**\|\ **b**\|\ **c**]
  11. Lists
  12. =====
  13. **Bullet list:**
  14. - Point A
  15. - Point B
  16. - Point C
  17. - Point D
  18. **Numbered list**:
  19. #. Point 1
  20. #. Point 2
  21. #. Point 3
  22. #. Point 4
  23. **Definition list**:
  24. term1
  25. Definition of term1
  26. term2
  27. Definition of term2
  28. Table
  29. =====
  30. ReST supports multiple ways to make a table.
  31. Simple Table
  32. ------------
  33. ===== ===== =======
  34. A B A and B
  35. ===== ===== =======
  36. False False False
  37. True False False
  38. False True False
  39. True True True
  40. ===== ===== =======
  41. Grid Table
  42. ----------
  43. .. _tbl-grid:
  44. +----------------------+------------+----------+----------+
  45. | Header row, column 1 | Header 2 | Header 3 | Header 4 |
  46. | | | | |
  47. +======================+============+==========+==========+
  48. | body row 1, column 1 | column 2 | column 3 | column 4 |
  49. +----------------------+------------+----------+----------+
  50. | body row 2 | ... | ... | |
  51. +----------------------+------------+----------+----------+
  52. Links
  53. =====
  54. External links
  55. --------------
  56. https://generic-mapping-tools.org
  57. `GMT Forum <https://forum.generic-mapping-tools.org/>`_
  58. Internal links
  59. --------------
  60. Link to the a module with :doc:`plot` or :doc:`/plot`.
  61. Link to a section title with `Lists`_.
  62. Link to a target with :ref:`Link to a table <tbl-grid>`.
  63. Link to a GMT parameter :term:`FONT_TITLE`.
  64. Codes
  65. =====
  66. ::
  67. gmt begin map
  68. gmt basemap -R0/10/0/10 -JX10c/10c -Baf
  69. gmt end
  70. Images
  71. ======
  72. Use the ``figure`` directive to include images:
  73. .. figure:: /_images/GMT_coverlogo.png
  74. :width: 90%
  75. Figure caption
  76. Math
  77. ====
  78. reST also supports LaTeX-style math.
  79. This is an inline math :math:`x^2+y^2=z^2`.
  80. For long equations, use the ``math`` directive:
  81. .. math::
  82. \gamma = \sqrt{(\alpha^2 + \beta^2)}
Tip!

Press p or to see the previous file or, n or to see the next file

Comments

Loading...