-
Notifications
You must be signed in to change notification settings - Fork 79
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
We should convert some or all of the documentation over to markdown! #340
Comments
note that markdown is supported within the docs already, so it's just a matter of renaming |
I noticed that Markdown doesn't have a way to make toctrees, and some of the documents like |
What we've done in other repos is:
* create a toc.rst that has all the files;
* make index.md be a front page without a toctree.
that seems to work ok.
|
* Reformatted .rst files in doc/ to .md files fix for issue 340 * Changed code for command-line.md for images from md to HTML to shrink plots * Fixed formatting errors in command-line.md and more-info.md * Turned index.rst into a toctree and made a new welcome-to-sourmash.md file with all the info from the previous index.rst file. fixed hyperlinks in all the edited files. * removed leading space from code blocks * restored index-rst to original form * fixed hyperlinks in tutorials.md
Fixed in #356. |
ReStructuredText is increasingly painful to edit :)
The text was updated successfully, but these errors were encountered: