Get Started

This page gives a quick overview of how to get started with sphinx-ymmsl.

Installation

To install sphinx-ymmsl use pip:

pip install sphinx-ymmsl

Configuration

To use sphinx-ymmsl in your Sphinx documentation project, you need to add it to the list of extensions in your conf.py file:

extensions = [
    'sphinx_ymmsl',
    # ... other extensions
]

Basic Usage

Once the extension is configured, you can use the .. ymmsl:: directive in your reStructuredText files to include documentation generated from a yMMSL file.

Syntax

The basic syntax is:

.. ymmsl:: path/to/your/file.ymmsl

The path should be relative to your Sphinx source directory (typically the docs/ folder).

When Sphinx builds your documentation, the .. ymmsl:: directive will:

Parse the yMMSL file
Generate formatted Markdown documentation
Convert the Markdown to HTML