search

opticks-org / opticks

Open source remote sensing analysis tool
https://www.opticks.org
GNU Lesser General Public License v2.1
51 stars 19 forks source link

Documentation Format? #7

Closed dwcaraway closed 11 months ago

dwcaraway commented 6 years ago

I usually build documentation in ReadTheDocs style formats, thoughts? and an example set of documentation for a mixed python / c++ library using SCons

tclarke commented 6 years ago

I was thinking wither ReadTheDocs, doxygen static files (only because the API docs are in doxygen) or a ssg tool like Jekyll or Hugo.

dwcaraway commented 6 years ago

ReadTheDocs (e.g. sphinx) will give you all of the support for compiling to HTML/CSS/JS, support restructured text and producing PDFs and other formats for offsite hosting. I use Jekyll for CMS, Github pages and blogging (along with other web-based databases to provide content), but generally don't find a lot of value for docs. Haven't used Hugo, expecting it to be similar. I've used doxygen in the past, worked well for generated docs from source code.

Here's a post on using rtd/sphinx to publish to github pages. Optionally, you can post to ReadTheDocs with themes.

github-actions[bot] commented 11 months ago

Stale issue message