Technical Document Example

1. Placeholder topic

Technical Document Example¶

1. Placeholder topic¶

Write in standard reStructuredText. For style guidance, see the Documentation Guidelines. See the source content below for some quickstart snippets to get started.

Include figures by referencing them:

To source figures from other GitLab repositories, use the figure-from-gitlab directive described in _templates/ext/README.

Add a list of figures:

List of figures:

Figure 1: A placeholder

Draw tables directly:

Table 1 A placeholder¶
Header row, column 1	Header 2†	Header 3	Header 4
body row 1, column 1	column 2	column 3	column 4
body row 2	column 2	column 3	column 4

† I’m a tablenote!

Or, include as csv:

Table 2 A CSV table placeholder¶
Treat	Quantity	Description
Albatross	2.99	On a stick!
Crunchy Frog	1.49	If they took the bones out, it wouldn’t feel crunchy, now would it?
Gannet Ripple	1.99	On a stick!

To source csv tables from other GitLab repositories, use the csv-from-gitlab directive described in _templates/ext/README.

Add a list of tables:

List of tables:

Table 1: A placeholder
Table 2: A CSV table placeholder

Write code directly:

Listing 1 Hello, world!¶

#include <iostream>

int main() {
    std::cout << "Hello world!";
    return 0;
}

Or, include as a separate file:

#include <iostream>

int main() {
    std::cout << "Hello World!";
    return 0;
}

Some math:

(1)¶\[a \Leftrightarrow 2\pi a\sum\limits_{k = - \infty }^\infty {\delta (\omega + 2\pi k)} ,( - \infty < n < \infty )\]

Refer to Fig. 1 and Table 1. Otherwise, refer to (1) or Listing 1.

Create glossary terms and glossaries. For example, USB.

USB¶: Universal Serial Bus

Add citations, these appear at the end of the document. For example, see [Ref]. Similarly, create footnotes. For example, footnote [1].

[Ref]

Book or article reference, website or whatever.

Contents

Technical Document Example

Contents

Technical Document Example¶

1. Placeholder topic¶