Studica Robotics FTC Documentation

https://docs.studica.com/en/latest/
Admin
Studica Robotics and FIRST Robotics Canada documentation providing build and programming tutorials...
Tokens:16,381
Snippets:164
Trust Score:9.2
Update:6 hours ago
Show doc for...
Tokens:
Raw
### C++ code block output

Source: https://docs.studica.com/en/latest/docs/Contributing/style-guide.html

The rendered C++ code from the tabs example.

```cpp
std::cout << "Hello World!";
```

--------------------------------

### Create tabs for Java and C++ code examples

Source: https://docs.studica.com/en/latest/docs/Contributing/style-guide.html

Demonstrates the Sphinx tabs directive to show code in Java and C++ tabs. The output displays each code block separately.

```rst
.. tabs::

   .. tab:: Java

      .. code-block:: java
         :linenos:

         System.out.println("Hello World!");

   .. tab:: C++

      .. code-block:: c++
         :linenos:

         std::cout << "Hello World!";
```

--------------------------------

### Java code block output

Source: https://docs.studica.com/en/latest/docs/Contributing/style-guide.html

The rendered Java code from the tabs example.

```java
System.out.println("Hello World!");
```

--------------------------------

### Simple Java code block with line numbers

Source: https://docs.studica.com/en/latest/docs/Contributing/style-guide.html

Example of a Java code block using the code-block directive with line numbers enabled. The rendered output shows the line number prefix.

```reStructuredText
.. code-block:: java
   :linenos:

   System.out.println("Hello to whomever is reading this.");
```

```text
1System.out.println("Hello to whomever is reading this.");
```

--------------------------------

### Java code block with emphasized lines

Source: https://docs.studica.com/en/latest/docs/Contributing/style-guide.html

Example of a Java code block using the :emphasize-lines: option to highlight lines 2 and 4. The rendered output shows the line numbers and the highlighted lines.

```reStructuredText
.. code-block:: java
   :linenos:
   :emphasize-lines: 2,4

   System.out.println("Hello to whomever is reading this.");
   System.out.println("I hope you learn something.");
   System.out.println("Its real important.");
   System.out.println("For success.");
```

```text
1System.out.println("Hello to whomever is reading this.");
2System.out.println("I hope you learn something.");
3System.out.println("Its real important.");
4System.out.println("For success.");
```

--------------------------------

### Create bullet and numeric lists

Source: https://docs.studica.com/en/latest/docs/Contributing/style-guide.html

Shows the syntax for bullet and numeric lists. Note that lists don't require a blank line between items.

```markdown
- This is
- a simple
- bullet lists

1. This is
2. a simple
3. numeric list
```

--------------------------------

### Admonition with description on same line

Source: https://docs.studica.com/en/latest/docs/Contributing/style-guide.html

Recommended way to use admonitions: place the description on the same line as the directive.

```rst
.. attention:: Description
```

--------------------------------

### Admonition with description on next line

Source: https://docs.studica.com/en/latest/docs/Contributing/style-guide.html

Alternative admonition syntax with description on the next line, shown as 'No' in the source.

```rst
.. attention::

   Description
```

--------------------------------

### Anonymous hyperlink syntax

Source: https://docs.studica.com/en/latest/docs/Contributing/style-guide.html

Format for anonymous hyperlinks in reStructuredText. The link text is followed by the URL in angle brackets, and the link is terminated with two underscores.

```reStructuredText
`Link <https://google.com>`__
```

--------------------------------

### code-block directive template

Source: https://docs.studica.com/en/latest/docs/Contributing/style-guide.html

Template for the code-block directive. Line numbers are required for any block containing code; the exception is when the block is used for unformatted text.

```reStructuredText
.. code-block:: (language)
   :linenos:

       Source code
```
Tokens:
Raw