{"id":26696056,"url":"https://github.com/executablebooks/rst-to-myst","last_synced_at":"2025-12-30T00:03:32.792Z","repository":{"id":39590750,"uuid":"323903915","full_name":"executablebooks/rst-to-myst","owner":"executablebooks","description":"Convert ReStructuredText to MyST Markdown","archived":false,"fork":false,"pushed_at":"2024-04-29T16:38:31.000Z","size":166,"stargazers_count":58,"open_issues_count":16,"forks_count":10,"subscribers_count":5,"default_branch":"main","last_synced_at":"2024-04-29T17:52:32.904Z","etag":null,"topics":["markdown","myst","restructuredtext","sphinx"],"latest_commit_sha":null,"homepage":"https://rst-to-myst.readthedocs.io","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/executablebooks.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-12-23T13:03:58.000Z","updated_at":"2024-06-17T18:28:36.820Z","dependencies_parsed_at":"2023-12-25T17:49:29.531Z","dependency_job_id":"42aab6d7-028b-44f5-bc8e-92c1a27db3cc","html_url":"https://github.com/executablebooks/rst-to-myst","commit_stats":{"total_commits":52,"total_committers":6,"mean_commits":8.666666666666666,"dds":0.25,"last_synced_commit":"eed8300c091d36defc36f58c1837c11ab2654854"},"previous_names":[],"tags_count":13,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/executablebooks%2Frst-to-myst","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/executablebooks%2Frst-to-myst/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/executablebooks%2Frst-to-myst/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/executablebooks%2Frst-to-myst/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/executablebooks","download_url":"https://codeload.github.com/executablebooks/rst-to-myst/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245727694,"owners_count":20662555,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["markdown","myst","restructuredtext","sphinx"],"created_at":"2025-03-26T20:01:01.644Z","updated_at":"2025-12-30T00:03:32.786Z","avatar_url":"https://github.com/executablebooks.png","language":"Python","funding_links":[],"categories":["Tools"],"sub_categories":["Converters"],"readme":"# rst-to-myst\n\n[![Build Status][ci-badge]][ci-link]\n[![codecov.io][cov-badge]][cov-link]\n[![PyPI version][pypi-badge]][pypi-link]\n\nConvert [ReStructuredText](https://docutils.sourceforge.io/) to [MyST Markdown](https://myst-parser.readthedocs.io/),\nand also explore available roles/directives.\n\nSee [tests/fixtures/render.txt](tests/fixtures/render.txt) for examples of inputs -\u003e outputs.\n\n## Install\n\n```bash\npip install rst-to-myst\n```\n\nor with sphinx:\n\n```bash\npip install rst-to-myst[sphinx]\n```\n\nTo then run a basic conversion of a whole project:\n\n```console\n$ rst2myst convert docs/**/*.rst\n```\n\nFor greater control, you can pass configuration with CLI options, or via a YAML configuration file:\n\n```console\n$ rst2myst convert --config config.yaml docs/**/*.rst\n```\n\n`config.yaml`:\n\n```yaml\nlanguage: en\nsphinx: true\nextensions:\n- sphinx_panels\ndefault_domain: py\nconsecutive_numbering: true\ncolon_fences: true\ndollar_math: true\nconversions:\n    sphinx_panels.dropdpwn.DropdownDirective: parse_all\n```\n\nSee the documentation for more information: \u003chttps://rst-to-myst.readthedocs.io/\u003e\n\n## Development\n\nThis package utilises [flit](https://flit.readthedocs.io) as the build engine, and [tox](https://tox.readthedocs.io) for test automation.\n\nTo install these development dependencies:\n\n```bash\npip install flit tox\n```\n\nTo run the tests:\n\n```bash\ntox\n```\n\nTo run the code formatting and style checks:\n\n```bash\npip install pre-commit\npre-commit run --all\n```\n\n## Publish to PyPi\n\nEither use flit directly:\n\n```bash\nflit publish\n```\n\nor trigger the GitHub Action job, by creating a release with a tag equal to the version, e.g. `v0.0.1`.\n\nNote, this requires generating an API key on PyPi and adding it to the repository `Settings/Secrets`, under the name `PYPI_KEY`.\n\n## TODO\n\nThe conversion covers almost all syntaxes (see \u003chttps://docutils.sourceforge.io/docs/user/rst/quickref.htm\u003e) except:\n\n- line blocks\n- option lists\n\nAlso custom functions for directive parsing would be desirable.\n\n[ci-badge]: https://github.com/executablebooks/rst-to-myst/workflows/CI/badge.svg?branch=main\n[ci-link]: https://github.com/executablebooks/rst-to-myst/actions?query=workflow%3ACI+branch%3Amain+event%3Apush\n[cov-badge]: https://codecov.io/gh/executablebooks/rst-to-myst/branch/main/graph/badge.svg\n[cov-link]: https://codecov.io/gh/executablebooks/rst-to-myst\n[pypi-badge]: https://img.shields.io/pypi/v/rst-to-myst.svg\n[pypi-link]: https://pypi.org/project/rst-to-myst\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fexecutablebooks%2Frst-to-myst","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fexecutablebooks%2Frst-to-myst","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fexecutablebooks%2Frst-to-myst/lists"}