New❖

Overview❖

DocLang allows projects to define their own commands to extend the DSL with custom behavior. New commands are useful when you want to generate additional documentation content, perform introspection or introduce project‑specific features that are not part of the default command set.

Example❖

New commands are created using the @Command.new() decorator. The decorator accepts the command name and the decorated function receives the current DocLang context and the parsed arguments.

For example, a simple command that prints a greeting:

1from sphinx_doclang.commands import Command
2
3@Command.new("hello")
4def hello_command(name, *args, **kwargs):
5    return f"Hello {name}!"

Notes❖

  • Command names must be unique.

  • Command names are not case sensitive.

  • Commands may accept arguments, but they are always passed as plain strings.

  • Commands run during documentation generation, so they should be fast and deterministic.

  • Commands must accept any number of positional and keyword arguments.

  • Commands must return either a single string or a list of strings.