I've used Nim's Docgen to generate a tutorial + documentation.

End result is [here](https://mratsim.github.io/Arraymancer/) which I'm quite 
happy with for the time invested.

A few remarks to ease its use:
    

  * It would be nice to prepend the autogenerated "API" doc with rst tutorials. 
As a workaround, I include a .nim file [full of 
commentaries](https://github.com/mratsim/Arraymancer/blob/087b5c82addf90fd3a569364613e89b683f011a1/docs/autogen_nim_API.nim)
  * I cannot seem to display images this way.
  * [See source 
switch](https://nim-lang.org/docs/docgen.html#related-options-see-source-switch)
 doesn't work.
    * It ignores `docSeeSrcUrl`. [Issue 
raised](https://github.com/nim-lang/Nim/issues/6071). Even if I don't specify 
it does a wrong link.
    * It seems non-trivial to link against a specific github commit
    * The `edit` link links to a devel branch (hardcoded).



I used find+replace to fix "See source issues" but it would be nice if 
automated.

Reply via email to