On Saturday, 24 February 2018 at 14:13:18 UTC, Joe wrote:
On Saturday, 24 February 2018 at 10:13:35 UTC, Paolo Invernizzi
[...]
As I said, I'm new and still not familiar with those facilities
although I saw those things and they looked like embedded HTML
and was wondering what they were for.
Again, coming from Python, I'm familiar with RTD
(https://readthedocs.org, my own open source Python/Postgres
project is hosted there) and Sphinx
(http://www.sphinx-doc.org/en/master/). Although it started
with Python, RTD now hosts many other kinds of projects
(Javascript, PHP, Ruby, etc.). There's even a project named
'dlang' (it's not what you expect!), but I did find "D Tips"
and "Quick Start with D" which appear to be standalone
Markdown. In any case, it would be nice to have such
automatically generated docs available in a public site/repo of
some kind, like RTD, so a potential user doesn't have to clone
the code and run the compiler to see it.
+1
I would even go so far 'force' people publishing to dub, to
provide documentation.
If no docs, present, than the libs should be marked as *docs
missing*. (Beside the number of Github stars)