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.

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

Transform .md files into documentation #39

Open
nathanshammah opened this issue Sep 29, 2020 · 0 comments
Open

Transform .md files into documentation #39

nathanshammah opened this issue Sep 29, 2020 · 0 comments

Comments

@nathanshammah
Copy link
Owner

It could be nice to transform the full guide from .md files into a documentation, thus generating a website such as the ones hosted on Read the Docs.

  • One way to go is to transform them into .rst files.
  • The other way is to use some markdown to rst converter, such as m2r or similar to do the job, keeping all the docs in md, but reorganizing them.

Example

The cirq documentation is in md files.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant