Quickstart¶

Declaring objects¶

Use lua:module to indicate which module you’re documenting. After it, use lua:data, lua:function, lua:class, and others to document module’s contents.

RST

.. lua:module:: soundboard

.. lua:class:: Sound

   A sound that can be played by the sound board.

Markdown

```{lua:module} soundboard
```

```{lua:class} Sound
A sound that can be played by the sound board.
```

Tip

Setting the primary domain

You can avoid prefixing directives and roles with lua: if you set Lua as your primary domain. For this, declare primary_domain in your conf.py:

primary_domain = "lua"

This will significantly reduce boilerplate in documentation:

RST

Cross-reference to :lua:`Sound`.

.. class:: Sound

   A sound that can be played by the sound board.

Markdown

Cross-reference to {lua}`Sound`.

```{class} Sound
A sound that can be played by the sound board.
```

Cross-referencing objects¶

Reference documented entities using the lua:data, lua:func, and lua:class roles:

RST

Here's a reference to the :lua:class:`soundboard.Sound` class.

Markdown

Here's a reference to the {lua:class}`soundboard.Sound` class.

Tip

Setting the default role

RST

When you use backticks without explicitly specifying a role, Sphinx uses the default role to resolve it. Setting lua:obj as the default role can reduce boilerplate in documentation.

In conf.py, declare default_role:

default_role = "lua:obj"

Now, you can reference any object with just backticks:

Reference to a `logging.Logger.info`.

Markdown

MySt plugin doesn’t support default roles. However, if you set lua as the primary domain, you’ll be able to use lua:lua like so:

Reference to a {lua}`logging.Logger.info`.

Automatic documentation generation¶

Use lua:autoobject to extract documentation from source code. Its options are similar to the ones used by python autodoc:

RST

.. lua:autoobject:: logging.Logger
   :members:

Markdown

```{lua:autoobject} logging.Logger
:members:
```