jester icon indicating copy to clipboard operation
jester copied to clipboard

publish docs and link to it in README (doc build failing in nimble directory)

Open timotheecour opened this issue 3 years ago • 0 comments

other popular packages link to docs (generated during push to master along with CI integration).

this should be doable with nim doc --project jester.nim

examples

  • https://github.com/nitely/nim-regex linking to https://nitely.github.io/nim-regex/regex.html
  • as part of travis: https://github.com/kaushalmodi/std_vector/blob/master/.travis.yml linking to https://kaushalmodi.github.io/std_vector/

links

  • https://github.com/dom96/jester/issues/185
  • https://github.com/dom96/jester/issues/256
  • https://vegansk.github.io/nimboost/docs/0.3.5/boost/http/jester.html

related

https://nimble.directory/pkg/jester shows doc build failing and https://nimble.directory/docs/jester shows only docs for 2 modules, eg: https://nimble.directory/docs/jester//jester/patterns.html https://nimble.directory/ci/badges/jester/nimdevel/doc_build_output.html tmp/nim_package_directory/cache/jester/pkgs/jester-0.4.3/jester.nim

nim doc --index:on /tmp/nim_package_directory/cache/jester/pkgs/jester-0.4.3/jester.nim /tmp/nim_package_directory/cache/jester/pkgs/jester-0.4.3/jester/request.nim(3, 22) Error: cannot open file: jester/private/utils

timotheecour avatar Sep 16 '20 00:09 timotheecour