Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Document how to use MyST as a python module #70

Closed
choldgraf opened this issue Feb 21, 2020 · 1 comment · Fixed by #83
Closed

Document how to use MyST as a python module #70

choldgraf opened this issue Feb 21, 2020 · 1 comment · Fixed by #83
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Milestone
Beta Release

Comments

@choldgraf
Copy link
Member

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.
@choldgraf choldgraf added documentation Improvements or additions to documentation enhancement New feature or request labels Feb 21, 2020
@chrisjsewell
Copy link
Member

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

@chrisjsewell chrisjsewell added this to the Beta Release milestone Feb 24, 2020
This was referenced Feb 27, 2020
Closed
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Milestone
Beta Release
Development

Successfully merging a pull request may close this issue.

Add API documentation and supporting code executablebooks/MyST-Parser
2 participants
@choldgraf @chrisjsewell