remove website generation code

The pieces being removed are: - `koch`'s "web" doc generation, which has the following differences to "regular" docs: - Docs meant for publishing have Google Analytics (GA) enabled. - `nimblepkglist` was bundled to enable the display of the nimble catalogue in "Standard library" page. This feature is no longer used, even on Nim's published docs, since it is fairly slow and was not updated for the new docs layout. Alternative providers like https://nimble.directory have completely superseded it. - Google Analytics script injection in docgen: The script is injected whenever `--doc.googleAnalytics:<GA code>` is passed to `nim doc`. - `nimweb`: A tool that appears to be used to generate the first generation of the Nim's website. Needless to say, it's pretty abandoned given the Jekyll-based version: https://github.com/nim-lang/website. We have no use for any of these, so shake them off to reduce code size. An added benefit is that koch docs is slightly faster as we are no longer generating the same documentation twice.
haxscramper · Jan 25, 2022 · d5fdfbf · d5fdfbf
1 parent 36ad310
commit d5fdfbf
Show file tree

Hide file tree

Showing 15 changed files with 5 additions and 998 deletions.
diff --git a/compiler/tools/docgen.nim b/compiler/tools/docgen.nim
@@ -113,7 +113,6 @@ type
                             # in `doc.section.toc2`
     toc: TocSectionsFinal  # final TOC (wrapped in `doc.section.toc`)
     indexValFilename: string
-    analytics: string  # Google Analytics javascript, "" if doesn't exist
     seenSymbols: StringTableRef # avoids duplicate symbol generation for HTML.
     jEntriesPre: seq[JsonItem] # pre-processed RST + JSON content
     jEntriesFinal: JsonNode    # final JSON after RST pass 2 and rendering
@@ -315,22 +314,6 @@ proc newDocumentor*(filename: AbsoluteFile; cache: IdentCache; conf: ConfigRef,
                    conf.configVars, filename.string,
                    docgenFindFile, compilerMsgHandler)
 
-  if conf.configVars.hasKey("doc.googleAnalytics"):
-    result.analytics = """
-<script>
-  (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
-  (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
-  m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
-  })(window,document,'script','//www.google-analytics.com/analytics.js','ga');
-
-  ga('create', '$1', 'auto');
-  ga('send', 'pageview');
-
-</script>
-    """ % [conf.configVars.getOrDefault"doc.googleAnalytics"]
-  else:
-    result.analytics = ""
-
   result.seenSymbols = newStringTable(modeCaseInsensitive)
   result.id = 100
   result.jEntriesFinal = newJArray()
@@ -1458,7 +1441,7 @@ proc genOutFile(d: PDoc, groupedToc = false): string =
         "title", title, "subtitle", subtitle, "tableofcontents", toc,
         "moduledesc", d.modDescFinal, "date", getDateStr(), "time", getClockStr(),
         "content", content, "author", d.meta[metaAuthor],
-        "version", esc(d.target, d.meta[metaVersion]), "analytics", d.analytics,
+        "version", esc(d.target, d.meta[metaVersion]),
         "deprecationMsg", d.modDeprecationMsg]
   else:
     code = content
@@ -1627,8 +1610,7 @@ proc commandBuildIndex*(conf: ConfigRef, dir: string, outFile = RelativeFile"")
       "title", "Index",
       "subtitle", "", "tableofcontents", "", "moduledesc", "",
       "date", getDateStr(), "time", getClockStr(),
-      "content", content, "author", "", "version", "", "analytics", ""]
-  # no analytics because context is not available
+      "content", content, "author", "", "version", ""]
 
   try:
     writeFile(filename, code)

diff --git a/config/nimdoc.cfg b/config/nimdoc.cfg
@@ -207,7 +207,6 @@ $content
 doc.listing_start = "<pre$3 class=\"listing\">"
 doc.listing_end = "</pre>"
 
-# * $analytics: Google analytics location, includes <script> tags
 doc.file = """<?xml version="1.0" encoding="utf-8" ?>
 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
   "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
@@ -290,7 +289,6 @@ window.addEventListener('DOMContentLoaded', main);
     </div>
   </div>
 </div>
-$analytics
 </body>
 </html>
 """
diff --git a/doc/docgen.rst b/doc/docgen.rst
@@ -293,13 +293,6 @@ by default.
 You can edit ``config/nimdoc.cfg`` and modify the ``doc.item.seesrc`` value
 with a hyperlink to your own code repository.
 
-In the case of Nim's own documentation, the `commit` value is just a commit
-hash to append to a formatted URL to https://github.com/nim-lang/Nim. The
-``tools/nimweb.nim`` helper queries the current git commit hash during the doc
-generation, but since you might be working on an unpublished repository, it
-also allows specifying a `githash` value in ``web/website.ini`` to force a
-specific commit in the output.
-
 
 Other Input Formats
 ===================

diff --git a/doc/koch.rst b/doc/koch.rst
@@ -68,21 +68,6 @@ driver of Nim's test suite. You can pass options to the `test`:option: command,
 they will be forwarded to the tester. See its source code for available
 options.
 
-web command
------------
-
-The `web`:idx: command converts the documentation in the `doc` directory
-from rst to HTML. It also repeats the same operation but places the result in
-the ``web/upload`` which can be used to update the website at
-https://nim-lang.org.
-
-By default, the documentation will be built in parallel using the number of
-available CPU cores. If any documentation build sub-commands fail, they will
-be rerun in serial fashion so that meaningful error output can be gathered for
-inspection. The `--parallelBuild:n`:option: switch or configuration option can be
-used to force a specific number of parallel jobs or run everything serially
-from the start (`n == 1`).
-
 pdf command
 -----------
 

diff --git a/nimdoc/rst2html/expected/rst_examples.html b/nimdoc/rst2html/expected/rst_examples.html
@@ -318,6 +318,5 @@ <h1><a class="toc-backref" id="introduction" href="#introduction">Introduction</
     </div>
   </div>
 </div>
-
 </body>
 </html>
diff --git a/nimdoc/test_out_index_dot_html/expected/index.html b/nimdoc/test_out_index_dot_html/expected/index.html
@@ -144,6 +144,5 @@ <h1><a class="toc-backref" href="#12">Procs</a></h1>
     </div>
   </div>
 </div>
-
 </body>
 </html>
diff --git a/nimdoc/test_out_index_dot_html/expected/theindex.html b/nimdoc/test_out_index_dot_html/expected/theindex.html
@@ -85,6 +85,5 @@ <h1 class="title">Index</h1>
     </div>
   </div>
 </div>
-
 </body>
 </html>
diff --git a/nimdoc/testproject/expected/subdir/subdir_b/utils.html b/nimdoc/testproject/expected/subdir/subdir_b/utils.html
@@ -353,6 +353,5 @@ <h1><a class="toc-backref" href="#18">Templates</a></h1>
     </div>
   </div>
 </div>
-
 </body>
 </html>
diff --git a/nimdoc/testproject/expected/testproject.html b/nimdoc/testproject/expected/testproject.html
@@ -1082,6 +1082,5 @@ <h1><a class="toc-backref" href="#18">Templates</a></h1>
     </div>
   </div>
 </div>
-
 </body>
 </html>
diff --git a/nimdoc/testproject/expected/theindex.html b/nimdoc/testproject/expected/theindex.html
@@ -385,6 +385,5 @@ <h1 class="title">Index</h1>
     </div>
   </div>
 </div>
-
 </body>
 </html>
diff --git a/tools/koch/koch.nim b/tools/koch/koch.nim
@@ -51,8 +51,6 @@ Options:
                            external components (default).
   --nim:path               use specified path for nim binary. This can also be used to
                            override the bootstrapping compiler.
-  --localdocs[:path]       only build local documentations. If a path is not
-                           specified (or empty), the default is used.
 Possible Commands:
   boot [options]           bootstraps with given command line options
   distrohelper [bindir]    helper for distro packagers
@@ -86,9 +84,6 @@ Commands for core developers:
                            specifying a category, e.g. `tests cat async`)
   temp options             creates a temporary compiler for testing
   testTools                run tooling testsuite
-Web options:
-  --googleAnalytics:UA-... add the given google analytics code to the docs. To
-                           build the official docs, use UA-48159761-1
 """
 
 # Set the compiler source location to what is given by `koch.py`.
@@ -270,20 +265,6 @@ proc binArchive(target: BinArchiveTarget, args: string) =
 
   archive(binaryArgs & " " & args)
 
-when false:
-  proc web(args: string) =
-    nimexec("js tools/dochack/dochack.nim")
-    nimexec("cc -r tools/nimweb.nim $# web/website.ini --putenv:nimversion=$#" %
-        [args, VersionAsString])
-
-  proc website(args: string) =
-    nimexec("cc -r tools/nimweb.nim $# --website web/website.ini --putenv:nimversion=$#" %
-        [args, VersionAsString])
-
-  proc pdf(args="") =
-    exec("$# cc -r tools/nimweb.nim $# --pdf web/website.ini --putenv:nimversion=$#" %
-        [findNim().quoteShell(), args, VersionAsString], additionalPATH=findNim().splitFile.dir)
-
 # -------------- boot ---------------------------------------------------------
 
 proc findStartNim: string =
@@ -650,8 +631,6 @@ when isMainModule:
   var op = initOptParser()
   var
     latest = false
-    localDocsOnly = false
-    localDocsOut = ""
 
   # Set SOURCE_DATE_EPOCH to cover other tooling that might make use of the
   # current time. Currently these tools are known to use the current time:
@@ -669,16 +648,12 @@ when isMainModule:
       of "latest": latest = true
       of "stable": latest = false
       of "nim": nimExe = op.val.absolutePath # absolute so still works with changeDir
-      of "localdocs":
-        localDocsOnly = true
-        if op.val.len > 0:
-          localDocsOut = op.val.absolutePath
       else: showHelp(success = false)
     of cmdArgument:
       case normalize(op.key)
       of "boot": boot(op.cmdLineRest)
       of "clean": clean(op.cmdLineRest)
-      of "doc", "docs": buildDocs(op.cmdLineRest, localDocsOnly, localDocsOut)
+      of "doc", "docs": buildDocs(op.cmdLineRest)
       of "pdf": buildPdfDoc(op.cmdLineRest, "doc/pdf")
       of "csource", "csources": csource(op.cmdLineRest)
       of "winrelease": binArchive(Windows, op.cmdLineRest)

diff --git a/tools/koch/kochdocs.nim b/tools/koch/kochdocs.nim
@@ -16,7 +16,6 @@ const
   nimArgs = "--errormax:3 --hint:Conf:off --hint:Path:off --hint:Processing:off --hint:XDeclaredButNotUsed:off --warning:UnusedImport:off -d:boot $#" % [docDefines]
   gitUrl = "https://github.com/nim-works/nimskull"
   docHtmlOutput = "doc/html"
-  webUploadOutput = "web/upload"
 
 var nimExe*: string
 var nimSource*: string
@@ -438,9 +437,6 @@ proc buildPdfDoc*(nimArgs, destPath: string) =
 
 proc buildJS(): string =
   let nim = findNim()
-  exec("$# js -d:release --out:$# tools/nimblepkglist.nim" %
-      [nim.quoteShell(), webUploadOutput / "nimblepkglist.js"])
-      # xxx deadcode? and why is it only for webUploadOutput, not for local docs?
   result = getDocHacksJs(nimr = getCurrentDir(), nim)
 
 proc buildDocsDir*(args: string, dir: string) =
@@ -457,23 +453,9 @@ proc buildDocsDir*(args: string, dir: string) =
   buildDocPackages(args, dir)
   copyFile(docHackJsSource, dir / docHackJsSource.lastPathPart)
 
-proc buildDocs*(args: string, localOnly = false, localOutDir = "") =
-  let localOutDir =
-    if localOutDir.len == 0:
-      docHtmlOutput
-    else:
-      localOutDir
-
+proc buildDocs*(args: string) =
   nimKeywordsBuildCheck()
 
   var args = args
 
-  if not localOnly:
-    buildDocsDir(args, webUploadOutput / NimVersion)
-
-    # XXX: Remove this feature check once the csources supports it.
-    when defined(nimHasCastPragmaBlocks):
-      let gaFilter = peg"@( y'--doc.googleAnalytics:' @(\s / $) )"
-      args = args.replace(gaFilter)
-
-  buildDocsDir(args, localOutDir)
+  buildDocsDir(args, docHtmlOutput)
diff --git a/tools/nimblepkglist.nim b/tools/nimblepkglist.nim
-Original file line number
+Diff line change
@@ Expand Up @@
         </div>
       </div>
     </div>
     </body>
     </html>