search

executablebooks / MyST-Parser

An extended commonmark compliant parser, with bridges to docutils/sphinx
https://myst-parser.readthedocs.io
MIT License
757 stars 196 forks source link

Document how to use MyST as a python module #70

Closed choldgraf closed 4 years ago

choldgraf commented 4 years ago

Thus far our documentation has focused on the Sphinx parsing and authoring side, but we should also document how to import MyST, run it on markdown, understand the AST, etc.

chrisjsewell commented 4 years ago

We should also use sphinx-apidoc in the conf.py to auto generate the API documentation, similar to what I do in: https://github.com/chrisjsewell/ase-notebook/blob/fdf5abb403c17f544453c1afd9e9bdaae4826a6d/docs/source/conf.py#L285