Sage-Bionetworks / synAnnotationUtils

Apache License 2.0
4 stars 2 forks source link

Create markdown documentation for each command #42

Closed sgosline closed 6 years ago

sgosline commented 6 years ago

If you write a script please put markdown in docs.

sgosline commented 6 years ago

Example is here by @xindiguo : https://github.com/Sage-Bionetworks/synAnnotationUtils/blob/develop/docs/sync_manifest.md

kdaily commented 6 years ago

Thought we had discussed using Sphinx (or some other Python docstring friendly tool)? This is fine by me too, just reminding if we had that discussion or not!

jaeddy commented 6 years ago

I think Sphinx and Markdown can coexist in the docs for a project: you'd still want Sphinx-style docstrings within classes and functions to enable things like autodoc and integration with ReadTheDocs (or similar sites), but Markdown could be more friendly for building out doc pages than RST (the default for Sphinx/ReadTheDocs). Relevant link here: http://www.sphinx-doc.org/en/stable/markdown.html

kdaily commented 6 years ago

I'm sold!

kdaily commented 6 years ago

Closing.