Mirror of forum.nim-lang.org

4941 :: How to compile/view the docs on localhost?

• ankush981 (orginal) [2019-06-17T02:28:46+02:00] view original

  Hello, I've downloaded the Nim repository and wanted to make some changes to the docs. I have edited the rst file, but I want to make sure the final output looks nice (not broken). What would be the command, etc., to build and view the documentation on localhost? I'm editing the tut1.rst file, by the way.

---

• kaushalmodi (orginal) [2019-06-17T05:30:04+02:00] view original

  I see that you intend to contribute to the Nim repo, so you would have already done the cloning step in step 1 in the instructions at https://github.com/nim-lang/Nim#compiling.

  For unix systems, step 2 is sh build_all.sh.

  And then koch docs creates the whole Nim documentation website locally.

---

• Araq (orginal) [2019-06-17T07:35:59+02:00] view original

  nim rst2html doc/tut1.rst and then open tut1.html.

---