https://github.com/executablebooks/sphinx-tomyst

A sphinx translator for producing myst syntax files
https://github.com/executablebooks/sphinx-tomyst

myst sphinx sphinx-translator

Last synced: about 2 months ago
JSON representation

A sphinx translator for producing myst syntax files

• Host: GitHub
• URL: https://github.com/executablebooks/sphinx-tomyst
• Owner: executablebooks
• License: mit
• Created: 2020-06-19T03:59:43.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2021-05-26T06:54:32.000Z (almost 4 years ago)
• Last Synced: 2024-09-05T02:40:09.488Z (9 months ago)
• Topics: myst, sphinx, sphinx-translator
• Language: Python
• Homepage:
• Size: 481 KB
• Stars: 4
• Watchers: 10
• Forks: 2
• Open Issues: 20
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-myst - sphinx-tomyst

README

        
# sphinx-tomyst

**Status:** In Development (alpha)

A sphinx translator for producing myst syntax files

[![Documentation Status](https://readthedocs.org/projects/sphinx-tomyst/badge/?version=latest)](https://sphinx-tomyst.readthedocs.io/en/latest/?badge=latest)

## Installation

**Step 1:** Install this package from `PyPI`:

```bash

pip install sphinx-tomyst

```

**Step 2:** Add `sphinx_tomyst` to your sphinx `extensions` in the `conf.py`

**Step 3:** then you can build using `make myst`