New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[doc] List of broken links in the doc site #9109

Closed
kaushalmodi opened this Issue Sep 28, 2018 · 5 comments

Comments

Projects
None yet
3 participants
@kaushalmodi
Copy link
Contributor

kaushalmodi commented Sep 28, 2018

I ran the htmltest link checker utility after building docs locally using this PR: #9103 (which fixes all the non-URL-encoded links).

htmltest started at 03:46:35 on ./doc/html
========================================================================
tools.html
  target does not exist --- tools.html --> c2nim.html
scgi.html
  target does not exist --- scgi.html --> sockets.html
  target does not exist --- scgi.html --> asyncio.html
terminal.html
  target does not exist --- terminal.html --> termios.html
  target does not exist --- terminal.html --> termios.html
json.html
  target does not exist --- json.html --> parsejson.html#JsonEventKind
  target does not exist --- json.html --> parsejson.html#JsonError
  target does not exist --- json.html --> parsejson.html#JsonParser
  target does not exist --- json.html --> parsejson.html#JsonKindError
  target does not exist --- json.html --> parsejson.html#open
  target does not exist --- json.html --> parsejson.html#close
  target does not exist --- json.html --> parsejson.html#str
  target does not exist --- json.html --> parsejson.html#getInt
  target does not exist --- json.html --> parsejson.html#getFloat
  target does not exist --- json.html --> parsejson.html#kind
  target does not exist --- json.html --> parsejson.html#getColumn
  target does not exist --- json.html --> parsejson.html#getLine
  target does not exist --- json.html --> parsejson.html#getFilename
  target does not exist --- json.html --> parsejson.html#errorMsg
  target does not exist --- json.html --> parsejson.html#errorMsgExpected
  target does not exist --- json.html --> parsejson.html#next
  target does not exist --- json.html --> parsejson.html#JsonParsingError
  target does not exist --- json.html --> parsejson.html#raiseParseErr
  target does not exist --- json.html --> parsejson.html
rdstdin.html
  target does not exist --- rdstdin.html --> linenoise.html
  target does not exist --- rdstdin.html --> termios.html
db_postgres.html
  target does not exist --- db_postgres.html --> db_odbc.html
db_mysql.html
  target does not exist --- db_mysql.html --> db_odbc.html
lib.html
  target does not exist --- lib.html --> fsmonitor.html
  target does not exist --- lib.html --> parseopt2.html
  target does not exist --- lib.html --> events.html
overview.html
  target does not exist --- overview.html --> trmacros.html
nimc.html
  target does not exist --- nimc.html --> sockets.html
  Non-OK status: 404 --- nimc.html --> https://github.com/jyapayne/switch-builder.git
  target does not exist --- nimc.html --> endb.html
  target does not exist --- nimc.html --> endb.html
  target does not exist --- nimc.html --> endb.html
random.html
  xoroshiro.di.unimi.it on 10.66.8.71:53: read udp 10.72.202.151:37567->10.66.8.71:53: i/o timeout --- random.html --> http://xoroshiro.di.unimi.it
osproc.html
  target does not exist --- osproc.html --> linux.html
asyncftpclient.html
  target does not exist --- asyncftpclient.html --> ftpclient.html
re.html
  target does not exist --- re.html --> rtarrays.html
threadpool.html
  target does not exist --- threadpool.html --> cpuload.html
docgen.html
  target does not exist --- docgen.html --> docgen.txt
  target does not exist --- docgen.html --> actors.html#^,ptr.TChannel[T]
backends.html
  target does not exist --- backends.html --> c2nim.html
cpuinfo.html
  target does not exist --- cpuinfo.html --> linux.html
db_sqlite.html
  target does not exist --- db_sqlite.html --> db_odbc.html
httpserver.html
  target does not exist --- httpserver.html --> sockets.html
  target does not exist --- httpserver.html --> asyncio.html
asyncfutures.html
  target does not exist --- asyncfutures.html --> cstrutils.html
manual.html
  target does not exist --- manual.html --> c2nim.html
========================================================================
✘✘✘ failed in 34.959906781s
51 errors in 159 documents

Araq added a commit that referenced this issue Sep 29, 2018

@kaushalmodi

This comment has been minimized.

Copy link
Contributor

kaushalmodi commented Sep 29, 2018

Updated htmltest results after that commit:

htmltest started at 01:23:28 on ./doc/html
========================================================================
asyncio.html
  target does not exist --- asyncio.html --> sockets.html
tools.html
  target does not exist --- tools.html --> c2nim.html
httpserver.html
  target does not exist --- httpserver.html --> sockets.html
ftpclient.html
  target does not exist --- ftpclient.html --> sockets.html
manual.html
  target does not exist --- manual.html --> c2nim.html
scgi.html
  target does not exist --- scgi.html --> sockets.html
backends.html
  target does not exist --- backends.html --> c2nim.html
========================================================================
✘✘✘ failed in 2.464803748s
7 errors in 171 documents
@kaushalmodi

This comment has been minimized.

Copy link
Contributor

kaushalmodi commented Sep 29, 2018

Now just 1 error remaining!

htmltest started at 03:04:43 on ./doc/html
========================================================================
nre.html
  target does not exist --- nre.html --> util.html
========================================================================
✘✘✘ failed in 3.707910133s
1 errors in 173 documents

Ref: https://gitter.im/nim-lang/Nim?at=5bafcce75af485306837bcf5

@kaushalmodi

This comment has been minimized.

Copy link
Contributor

kaushalmodi commented Oct 1, 2018

@Araq docgen is creating a hyperlink for a private import in nre:

import nre.private.util

Should that hyperlink be created in the first place?

@Araq Araq closed this in 4e120d5 Oct 1, 2018

@kaushalmodi

This comment has been minimized.

Copy link
Contributor

kaushalmodi commented Oct 1, 2018

@Araq The commit looks fine.. though we have to deal with the problem when some other module gets its own private/util.nim (otherwise the doc/html/util.html will keep on getting overwritten..). Shouldn't modules local to other modules be in that module's dir? But yeah.. may be a problem to tackle for another day.


and I confirm the docs to be good now!

htmltest started at 11:01:39 on ./doc/html
========================================================================
✔✔✔ passed in 1.972275573s
tested 174 documents

Would you accept a PR to run htmltest if that runs only once a day?

@Araq

This comment has been minimized.

Copy link
Member

Araq commented Oct 1, 2018

But yeah.. may be a problem to tackle for another day.

Yup.

Would you accept a PR to run htmltest if that runs only once a day?

Tried to explain to you that you should burden nightlies with this and I await your PRs on nightlies.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment