Mirror of forum.nim-lang.org

9161 :: problem with doc gen and runnableExamples

• stoneface86 (orginal) [2022-05-18T16:53:29+02:00] view original

  Started adding some runnableExamples to my documentation and now running nim doc fails.

  
  nim doc --project --index:on --outdir:htmldocs -p:"C:\Files\projects\libtrackerboy\src" src/trackerboy.nim
  Run

  Results in

  
  Hint: used config file 'C:\Users\Bren (Work)\.choosenim\toolchains\nim-1.6.6\config\nim.cfg' [Conf]
  Hint: used config file 'C:\Users\Bren (Work)\.choosenim\toolchains\nim-1.6.6\config\config.nims' [Conf]
  Hint: used config file 'C:\Users\Bren (Work)\.choosenim\toolchains\nim-1.6.6\config\nim.cfg' [Conf]
  Hint: used config file 'C:\Users\Bren (Work)\.choosenim\toolchains\nim-1.6.6\config\config.nims' [Conf]
  Hint: used config file 'C:\Users\Bren (Work)\.choosenim\toolchains\nim-1.6.6\config\nimdoc.cfg' [Conf]
  ..............................................................'C:\Users\Bren' is not recognized as an internal or external command,
  operable program or batch file.
  [runnableExamples] failed: generated file: 'C:\Users\Bren (Work)\nimcache\trackerboy_d\runnableExamples\common_group0_examples.nim' group: 'rdoccmd:
  docCmd:
  code: # autogenerated by docgen
  # source: C:\Files\projects\libtrackerboy\src\trackerboy\common.nim
  # rdoccmd:
  import "C:\\Users\\Bren (Work)\\nimcache\\trackerboy_d\\runnableExamples\\common_examples_1.nim"
  import "C:\\Users\\Bren (Work)\\nimcache\\trackerboy_d\\runnableExamples\\common_examples_2.nim"
  import "C:\\Users\\Bren (Work)\\nimcache\\trackerboy_d\\runnableExamples\\common_examples_3.nim"
  import "C:\\Users\\Bren (Work)\\nimcache\\trackerboy_d\\runnableExamples\\common_examples_4.nim"
  import "C:\\Users\\Bren (Work)\\nimcache\\trackerboy_d\\runnableExamples\\common_examples_5.nim"
  import "C:\\Users\\Bren (Work)\\nimcache\\trackerboy_d\\runnableExamples\\common_examples_6.nim"
  
  index: 0
  ' cmd: "C:\Users\Bren (Work)\.choosenim\toolchains\nim-1.6.6\bin\nim.exe" c -r --lib:"C:\Users\Bren (Work)\.choosenim\toolchains\nim-1.6.6\lib" --warning:UnusedImport:off --path:C:\Files\projects\libtrackerboy\src --nimcache:"C:\Users\Bren (Work)\nimcache\trackerboy_d\runnableExamples"   "C:\Users\Bren (Work)\nimcache\trackerboy_d\runnableExamples\common_group0_examples.nim"
  Run

  Looks like it's running C:\Users\Bren as a command instead of C:\Users\Bren (Work)\.choosenim\toolchains\nim-1.6.6\bin\nim.exe

  Works fine when nim is installed in a path without any spaces, ie C:\Users\Bren\.choosenim\toolchains\nim-1.6.6\nim.exe

---

• stoneface86 (orginal) [2022-05-18T20:47:21+02:00] view original

  Might be a bug with os.execShellCmd https://github.com/nim-lang/Nim/blob/devel/compiler/docgen.nim#L536

  import std/os
  echo execShellCmd("\"C:\\Users\\Bren (Work)\\.choosenim\\toolchains\\nim-1.6.6\\bin\\nim.exe\" -v")
  echo execShellCmd("\"C:\\Users\\Bren (Work)\\.choosenim\\toolchains\\nim-#devel\\bin\\nim.exe\" c -r --lib:\"C:\\Users\\Bren (Work)\\.choosenim\\toolchains\\nim-#devel\\lib\" --warning:UnusedImport:off --path:C:\\Files\\projects\\libtrackerboy\\src --nimcache:\"C:\\Users\\Bren (Work)\\nimcache\\trackerboy_d\\runnableExamples\"   \"C:\\Users\\Bren (Work)\\nimcache\\trackerboy_d\\runnableExamples\\common_group0_examples.nim\"")
  Run

  Prints:

  
  Nim Compiler Version 1.7.1 [Windows: amd64]
  Compiled at 2022-05-18
  Copyright (c) 2006-2022 by Andreas Rumpf
  
  active boot switches: -d:release
  0
  'C:\Users\Bren' is not recognized as an internal or external command,
  operable program or batch file.
  1
  Run

---

• PMunch (orginal) [2022-05-18T20:55:47+02:00] view original

  This should definitely be posted as a GitHub issue (assuming one doesn't already exist), and not as an easily lost forum post.

---

• stoneface86 (orginal) [2022-05-18T21:23:03+02:00] view original

  Definitely. Made a post here first since I was unsure if it was a bug or user error.

  Just made an issue for it here - https://github.com/nim-lang/Nim/issues/19803

---