Metadata-Version: 2.4
Name: sphinx-ymmsl
Version: 0.1.0
Summary: Sphinx plugin for documenting yMMSL models
Author-email: Iris van der Werf <ivanderwerf@ignitioncomputing.com>, Maarten Sebregts <msebregts@ignitioncomputing.com>
License-Expression: Apache-2.0
Project-URL: homepage, https://github.com/multiscale/sphinx-ymmsl
Project-URL: documentation, https://sphinx-ymmsl.readthedocs.io/
Project-URL: issues, https://github.com/multiscale/sphinx-ymmsl/issues
Requires-Python: >=3.7
Description-Content-Type: text/markdown
License-File: LICENSE.txt
Requires-Dist: myst-parser
Requires-Dist: ymmsl>=0.15
Provides-Extra: dev
Requires-Dist: ruff; extra == "dev"
Requires-Dist: pytest; extra == "dev"
Requires-Dist: pytest-cov; extra == "dev"
Provides-Extra: docs
Requires-Dist: sphinx_rtd_theme; extra == "docs"
Dynamic: license-file

# sphinx-ymmsl: Sphinx plugin for documenting yMMSL models

This project provides a sphinx plugin for documenting yMMSL models, used with the
MUSCLE3 simulation framework.
See the [online documentation](https://sphinx-ymmsl.readthedocs.io/) for more details.

## Installation

`sphinx-ymmsl` is available on [PyPI](https://pypi.org/project/sphinx-ymmsl/) and can be
installed with `pip`:

```bash
pip install sphinx-ymmsl
```

## Build documentation

Documentation for this project can be generated using Sphinx. The following `make`
command will build HTML documentation, which you can view by opening
`docs/_build/html/index.html` in a web browser.

```bash
make -C docs html
```

# Legal

Copyright 2026 ITER Organization. The code in this repository is licensed under the
[Apache-2.0 license](LICENSE.txt)
