ocean
ocean copied to clipboard
sociomantic-tsunami
Generate and publish documentation
https://readthedocs.org/ can be an option.
readthedocs.org is mostly used for manuals, isn't it. Maybe you can provide an example when using it for documenting an API. Because this seems to be the use case here.
harbored-mod is an option but its default style style needs to be improved. I feel it does not look good. Maybe there are other well designed and usable styles that one can use with it.
We were already (internally) generating the documentation using harbored-mod. The advantage of it is that it avoids DDOC macros/syntax which makes the documentation inlined in source code quite unreadable IMHO (and in opinion of some others), but it uses markdown which is a fine compromise. There are several functional quirks in harbored-mod that need to be tide up as well.
I thought you could just use readthedocs as a hosting of static pages, but on a quick look it seems like you have to build your docs in there. Another alternative would be GitHub Pages (I'm not super excited about having a branch for generated docs that grow and grow in the repo though, although in terms of storage it will probably be very efficient because it can potentially reuse a lot of Git objects since docs don't change that often as code).
To me using github pages sounds like a most natural choice.
