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

Use markdown files for building docs #218

Closed
creisle opened this issue Jul 2, 2020 · 0 comments · Fixed by #223
Closed

Use markdown files for building docs #218

creisle opened this issue Jul 2, 2020 · 0 comments · Fixed by #223

Comments

@creisle
Copy link
Member

creisle commented Jul 2, 2020

  • use markdown instead of rst for building docs. And build user manual with mkdocs and markdown_refdocs
  • this is more readable for editing individual files
  • will need to test that this is still publishable via readthedocs
creisle added a commit that referenced this issue Jul 2, 2020
@creisle creisle linked a pull request Jul 6, 2020 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant