Open dkav opened 6 years ago
For when we get to this, here is a nugget from an e-mail thread: "Here is a blog post explaining the differences between the two. The Natural Capital Project uses reST for both its api docs and user guide, while Julia uses Markdown." Links: https://eli.thegreenplace.net/2017/restructuredtext-vs-markdown-for-technical-documentation/ https://bitbucket.org/natcap/invest/src/d526f26f1e4fa89cf85d1291a145b4488eb9fb9e/doc/api-docs/?at=develop https://bitbucket.org/natcap/invest.users-guide/src https://github.com/JuliaLang/julia/tree/master/doc/src/manual
From Nik in another e-mail thread: "In the future, you might consider using Markdown, restructured text (rst), or asciidoc for you documentation, which would avoid this problem since they are pure text markup formats. Markdown is great for online docs, rst and asciidoc are easier for creating PDFs."
Darren: Also, if the project switches to using Python toolboxes (.pyt) this would also eliminate .tbx files too.
@johngallo I created a separate issue (#46) for Python toolboxes.
Convert documents from .docx format to a markup language such as reStructuredText (rst) or Markdown.