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

We should convert some or all of the documentation over to markdown! #340

Closed
ctb opened this issue Sep 28, 2017 · 4 comments
Closed

We should convert some or all of the documentation over to markdown! #340

ctb opened this issue Sep 28, 2017 · 4 comments

Comments

@ctb
Copy link
Contributor

ctb commented Sep 28, 2017

ReStructuredText is increasingly painful to edit :)

@ctb
Copy link
Contributor Author

ctb commented Sep 28, 2017

note that markdown is supported within the docs already, so it's just a matter of renaming .rst files to .md and editing the headers and links. And index needs to remain a .rst file so that the site is built properly.

@connor-reid-tiffany
Copy link
Contributor

I noticed that Markdown doesn't have a way to make toctrees, and some of the documents like developer.rst and release.rst aren't in index.rst, and rely on the toctree inside more-info.rst to be accessed on readthedocs.io. There is, however, a docutils bridge called recommonmark that can be used inside Sphinx, that would enable the use of reStructured text toctrees inside of a markdown document. Alternatively, i guess we could add the hidden files to the index.rst file (and get rid of toctrees in the documents), or keep the documentation as .rst. Let me know what you think I should try.

@ctb
Copy link
Contributor Author

ctb commented Oct 6, 2017 via email

luizirber pushed a commit that referenced this issue Oct 27, 2017
*  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
@ctb
Copy link
Contributor Author

ctb commented Feb 18, 2018

Fixed in #356.

@ctb ctb closed this as completed Feb 18, 2018
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

2 participants