diff options
author | Kaushal Modi <kaushal.modi@gmail.com> | 2018-09-28 13:12:28 -0400 |
---|---|---|
committer | Kaushal Modi <kaushal.modi@gmail.com> | 2018-09-29 13:15:29 -0400 |
commit | 2e5c759736a9458b192a3beb2cf3a38b2f198887 (patch) | |
tree | 9678795f664c69a5827aa214820b8831cf8e3252 | |
parent | 40e01d8549ce3c278dbe791d7af4f1e73b4d56da (diff) | |
download | Nim-2e5c759736a9458b192a3beb2cf3a38b2f198887.tar.gz |
Make "koch docs" copy the dochack.js to the right location too
- Fixes https://github.com/nim-lang/Nim/issues/9104. - Fixes https://github.com/nim-lang/Nim/issues/9095. Expect dochack.js to be fetched from the doc/html/ dir instead of from doc/. Also remove an unused and unexported proc pathPart.
-rw-r--r-- | .travis.yml | 5 | ||||
-rw-r--r-- | config/nimdoc.cfg | 2 | ||||
-rw-r--r-- | nimdoc/testproject/expected/subdir/subdir_b/utils.html | 2 | ||||
-rw-r--r-- | nimdoc/testproject/expected/testproject.html | 2 | ||||
-rw-r--r-- | nimdoc/testproject/expected/theindex.html | 2 | ||||
-rw-r--r-- | tools/kochdocs.nim | 18 |
6 files changed, 16 insertions, 15 deletions
diff --git a/.travis.yml b/.travis.yml index 1e2022654..51e5d4841 100644 --- a/.travis.yml +++ b/.travis.yml @@ -53,12 +53,9 @@ script: - nim c -r nimdoc/tester before_deploy: - # Generate the dochack.js for the doc search to work. - - nim js ./tools/dochack/dochack.nim - - cp -f ./tools/dochack/nimcache/dochack.js ./doc/. # Make https://nim-lang.github.io/Nim work the same as https://nim-lang.github.io/Nim/overview.html - cp -f ./doc/html/overview.html ./doc/html/index.html -deploy: +deploy: # https://nim-lang.github.io/Nim provider: pages # local-dir *has* to be a relative path from the repo root. local-dir: "doc/html" diff --git a/config/nimdoc.cfg b/config/nimdoc.cfg index 960c58c9e..a955254f2 100644 --- a/config/nimdoc.cfg +++ b/config/nimdoc.cfg @@ -1374,7 +1374,7 @@ span.pragmawrap { </style> -<script type="text/javascript" src="../dochack.js"></script> +<script type="text/javascript" src="dochack.js"></script> <script type="text/javascript"> function main() { diff --git a/nimdoc/testproject/expected/subdir/subdir_b/utils.html b/nimdoc/testproject/expected/subdir/subdir_b/utils.html index d81be8f48..8ba90657b 100644 --- a/nimdoc/testproject/expected/subdir/subdir_b/utils.html +++ b/nimdoc/testproject/expected/subdir/subdir_b/utils.html @@ -1199,7 +1199,7 @@ span.pragmawrap { </style> -<script type="text/javascript" src="../dochack.js"></script> +<script type="text/javascript" src="dochack.js"></script> <script type="text/javascript"> function main() { diff --git a/nimdoc/testproject/expected/testproject.html b/nimdoc/testproject/expected/testproject.html index f1c567627..2ea18323f 100644 --- a/nimdoc/testproject/expected/testproject.html +++ b/nimdoc/testproject/expected/testproject.html @@ -1199,7 +1199,7 @@ span.pragmawrap { </style> -<script type="text/javascript" src="../dochack.js"></script> +<script type="text/javascript" src="dochack.js"></script> <script type="text/javascript"> function main() { diff --git a/nimdoc/testproject/expected/theindex.html b/nimdoc/testproject/expected/theindex.html index 106a3be1d..865e5a28e 100644 --- a/nimdoc/testproject/expected/theindex.html +++ b/nimdoc/testproject/expected/theindex.html @@ -1199,7 +1199,7 @@ span.pragmawrap { </style> -<script type="text/javascript" src="../dochack.js"></script> +<script type="text/javascript" src="dochack.js"></script> <script type="text/javascript"> function main() { diff --git a/tools/kochdocs.nim b/tools/kochdocs.nim index ed135f579..2a51a1c8e 100644 --- a/tools/kochdocs.nim +++ b/tools/kochdocs.nim @@ -7,8 +7,9 @@ const nimArgs = "--hint[Conf]:off --hint[Path]:off --hint[Processing]:off -d:boot --putenv:nimversion=$#" % system.NimVersion gitUrl = "https://github.com/nim-lang/Nim" - docHtmlOutput = "doc/html" - webUploadOutput = "web/upload" + docHtmlOutput = "doc" / "html" + webUploadOutput = "web" / "upload" + docHackDir = "tools" / "dochack" proc exe*(f: string): string = result = addFileExt(f, ExeExt) @@ -267,8 +268,6 @@ proc buildDocSamples(nimArgs, destPath: string) = exec(findNim() & " doc $# -o:$# $#" % [nimArgs, destPath / "docgen_sample.html", "doc" / "docgen_sample.nim"]) -proc pathPart(d: string): string = splitFile(d).dir.replace('\\', '/') - proc buildDoc(nimArgs, destPath: string) = # call nim for the documentation: var @@ -325,11 +324,15 @@ proc buildPdfDoc*(nimArgs, destPath: string) = proc buildJS() = exec(findNim() & " js -d:release --out:$1 web/nimblepkglist.nim" % [webUploadOutput / "nimblepkglist.js"]) - exec(findNim() & " js tools/dochack/dochack.nim") + exec(findNim() & " js " & (docHackDir / "dochack.nim")) proc buildDocs*(args: string) = - let a = nimArgs & " " & args - buildJS() + let + a = nimArgs & " " & args + docHackJs = "dochack.js" + docHackJsSource = docHackDir / "nimcache" / docHackJs + docHackJsDest = docHtmlOutput / docHackJs + buildJS() # This call generates docHackJsSource let docup = webUploadOutput / NimVersion createDir(docup) buildDocSamples(a, docup) @@ -340,3 +343,4 @@ proc buildDocs*(args: string) = createDir(docHtmlOutput) buildDocSamples(nimArgs, docHtmlOutput) buildDoc(nimArgs, docHtmlOutput) + copyFileWithPermissions(docHackJsSource, docHackJsDest) |