Heading 1 with bold

Autodoc

<aside> 💡 Example

<aside> 💡 Code

.. autofunction:: example_module.greet

.. autoclass:: example_module.Calculator
   :members:

</aside>

<aside> 💡 Output

<aside> 📋 example_module.greet(*, name: str) -> str

Return a greeting message.

• Args:

  name: The name to greet.

• Returns:

  A greeting string.

</aside>

<aside> 📋 class example_module.Calculator(*, initial_value: float = 0)

A simple calculator class for demonstration.

<aside> 📋 add(*, amount: float) -> float

Add an amount to the current value.

• Args:

  amount: The amount to add.

• Returns:

  The new value.

</aside>

</aside>

</aside>

</aside>

Autosummary

<aside> 💡 Example

<aside> 💡 Code

.. autosummary::
   :nosignatures:

   example_module.greet
   example_module.Calculator

</aside>

<aside> 💡 Output

</aside>

Rubric

<aside> 💡 Example

<aside> 💡 Code

.. rubric:: This is a rubric heading

Rubrics are informal headings that don't appear in the table of contents.

.. rubric:: A rubric with ``code`` and *italic*

Rubrics can contain inline formatting like code and emphasis.

</aside>

<aside> 💡 Output

This is a rubric heading

Rubrics are informal headings that don’t appear in the table of contents.

A rubric with code and italic

Rubrics can contain inline formatting like code and emphasis.

</aside>

</aside>

Definition Lists

<aside> 💡 Example

<aside> 💡 Code

term
   Definition for a simple term.

``code_term``
   Definition lists preserve inline formatting like code in terms.

*emphasized* term
   Terms can also have emphasis and other formatting.

term : classifier
   Classifiers are appended to the term with colons.

</aside>

<aside> 💡 Output

• term

  Definition for a simple term.

• code_term

  Definition lists preserve inline formatting like code in terms.

• emphasized term

  Terms can also have emphasis and other formatting.

• term : classifier

  Classifiers are appended to the term with colons.

</aside>

</aside>

Describe

<aside> 💡 Example

<aside> 💡 Code

.. describe:: Foo

   This is a describe directive example.

</aside>

<aside> 💡 Output

<aside> 📋 Foo

This is a describe directive example.

</aside>

</aside>

</aside>

Comments

<aside> 💡 Example

<aside> 💡 Code

.. This is a comment that demonstrates comment support.
   Comments should not appear in the final output.

</aside>

<aside> 💡 Output

</aside>

</aside>

Text Formatting

<aside> 💡 Example

<aside> 💡 Code

This is **bold** and *italic* and ``inline code``.

This text has :strike:`strike` formatting and :del:`deleted text` as well.

The builder supports colored text using `sphinxcontrib-text-styles <https://sphinxcontrib-text-styles.readthedocs.io/>`_:

This is :text-red:`red text`, :text-blue:`blue text`, :text-green:`green text`, :text-yellow:`yellow text`, :text-orange:`orange text`, :text-purple:`purple text`, :text-pink:`pink text`, :text-brown:`brown text`, and :text-gray:`gray text`.

The builder also supports background colors using `sphinxcontrib-text-styles <https://sphinxcontrib-text-styles.readthedocs.io/>`_:

This is :bg-red:`red background text`, :bg-blue:`blue background text`, :bg-green:`green background text`, :bg-yellow:`yellow background text`, :bg-orange:`orange background text`, :bg-purple:`purple background text`, :bg-pink:`pink background text`, :bg-brown:`brown background text`, and :bg-gray:`gray background text`.

The builder supports additional text styles: :text-bold:`bold text`, :text-italic:`italic text`, :text-mono:`monospace text`, :text-strike:`strikethrough text`, and :text-underline:`underlined text`.

The builder supports keyboard shortcuts using the standard ``:kbd:`` role: Press :kbd:`Ctrl+C` to copy, :kbd:`Ctrl+V` to paste.

The builder supports file paths using the standard ``:file:`` role: Edit the :file:`config.py` file or check :file:`/etc/hosts`.

</aside>

<aside> 💡 Output

This is bold and italic and inline code.

This text has strike formatting and deleted text as well.

The builder supports colored text using sphinxcontrib-text-styles:

This is red text, blue text, green text, yellow text, orange text, purple text, pink text, brown text, and gray text.

The builder also supports background colors using sphinxcontrib-text-styles:

This is red background text, blue background text, green background text, yellow background text, orange background text, purple background text, pink background text, brown background text, and gray background text.

The builder supports additional text styles: bold text, italic text, monospace text, strikethrough text, and underlined text.

The builder supports keyboard shortcuts using the standard :kbd: role: Press Ctrl+C to copy, Ctrl+V to paste.

The builder supports file paths using the standard :file: role: Edit the config.py file or check /etc/hosts.

</aside>

</aside>

Links

Link with a title

<aside> 💡 Example

<aside> 💡 Code

Link to `Google <https://google.com>`_

</aside>

<aside> 💡 Output

Link to Google

</aside>

</aside>

Link with no title