RST-to-MyST

https://rst-to-myst.readthedocs.io/

Admin

RST-to-MyST is a tool for converting reStructuredText documents and Sphinx projects into MyST...

Tokens:392

Snippets:7

Trust Score:9.6

Update:1 month ago

Show doc for...

Tokens:

Raw

### Install and verify via pipx

Source: https://rst-to-myst.readthedocs.io

Installs the package into an isolated environment and lists installed packages.

```bash
$ pipx install "rst-to-myst[sphinx]"
$ pipx list
venvs are in /Users/username/.local/pipx/venvs
apps are exposed on your $PATH at /Users/username/.local/bin
   package rst-to-myst 0.1.2, Python 3.7.3
    - rst2myst
```

--------------------------------

### Example YAML configuration

Source: https://rst-to-myst.readthedocs.io

A sample configuration file defining language, Sphinx settings, and specific directive conversions.

```yaml
language: en
sphinx: true
extensions:
- sphinx_panels
default_domain: py
consecutive_numbering: true
colon_fences: true
dollar_math: true
conversions:
    sphinx_panels.dropdown.DropdownDirective: parse_all
```

--------------------------------

### Install RST-to-MyST via pip

Source: https://rst-to-myst.readthedocs.io

Installs the package and optional Sphinx dependencies from PyPI.

```bash
pip install "rst-to-myst[sphinx]"
```

--------------------------------

### Convert with configuration file

Source: https://rst-to-myst.readthedocs.io

Runs the conversion using a specified YAML configuration file for greater control.

```bash
$ rst2myst convert --config config.yaml docs/**/*.rst
```

--------------------------------

### Convert RST files via CLI

Source: https://rst-to-myst.readthedocs.io

Executes a basic conversion of ReStructuredText files to MyST Markdown.

```bash
$ rst2myst convert docs/**/*.rst
```

Tokens:

Raw