Mirror of forum.nim-lang.org

5853 :: Docgen is underdocumented, requesting assistance

• moigagoo (orginal) [2020-01-24T11:37:29+01:00] view original

  I want to use Nim's built-in documentation generating facilities to generates the docs for Norm: https://moigagoo.github.io/norm/

  However, there're issues I'm facing and cannot find the solution for.

  1. How to I generate an index link Nim's own https://nim-lang.org/docs/theindex.html ? My index built with "nim buildIndex" looks quite poor in comparison: https://moigagoo.github.io/norm/api/theindex.html

  Why does mine not show the modules and stuff? How does Nim put the module name at the top of every page, e.g. https://nim-lang.org/docs/math.html?

  2. How do I generate TOC with rst2html? It's included in the generated docs if you call nim doc but not included if you call nim rst2html.
  3. Why is a submodule ignored by nim doc`` command? ``sqlite`` folder is generated https://github.com/moigagoo/norm/tree/gh-pages/api/norm but ``postgres is not, although they both exist in the code: https://github.com/moigagoo/norm/tree/develop/src/norm

  Here are the commands I'm calling to generate the docs: https://github.com/moigagoo/norm/blob/feature/docs/norm.nimble#L15

---

• leorize (orginal) [2020-01-24T17:30:41+01:00] view original

  FWIW, this is how nim docs are generated: https://github.com/nim-lang/Nim/blob/devel/tools/kochdocs.nim#L363

---