diff options
| author | Timothee Cour <timothee.cour2@gmail.com> | 2018-08-05 03:15:40 -0700 |
|---|---|---|
| committer | Andreas Rumpf <rumpf_a@web.de> | 2018-08-05 12:15:40 +0200 |
| commit | baa77387d7b9ecda84a58af2fed515cb32cb2a5b (patch) | |
| tree | 2e2d47e5f99a14945ffb4c9f2e258735158cc212 | |
| parent | c57e320c9486248a82c19d13e03178745d8eb53f (diff) | |
| download | Nim-baa77387d7b9ecda84a58af2fed515cb32cb2a5b.tar.gz | |
fixes #8215; remove reference to old doc command which was deprecated (#8418)
| -rw-r--r-- | doc/docgen.rst | 21 | ||||
| -rw-r--r-- | tools/nimweb.nim | 10 |
2 files changed, 6 insertions, 25 deletions
diff --git a/doc/docgen.rst b/doc/docgen.rst index d196b3a18..fa23bdc79 100644 --- a/doc/docgen.rst +++ b/doc/docgen.rst @@ -97,24 +97,9 @@ Partial Output:: proc helloWorld(times: int) {.raises: [], tags: [].} ... -The full output can be seen here: `docgen_sample2.html <docgen_sample2.html>`_. - -The older version of the ``doc`` command, now renamed ``doc0`` runs before -semantic checking which means it lacks some of the things ``doc`` will output. - -The ``doc0`` command:: - nim doc0 sample - -Partial Output:: - ... - proc helloWorld*(times: int) - ... - -Output can be viewed in full here: `docgen_sample.html <docgen_sample.html>`_. -As you can see, the tool has extracted less information than what the ``doc`` -command provides, such as pragmas attached implicitly by the compiler. This type -of information is not available from looking at the AST (Abstract Syntax Tree) -prior to semantic checking, which is why ``doc0`` doesn't show it. +The full output can be seen here: `docgen_sample.html <docgen_sample.html>`_. +It runs after semantic checking, and includes pragmas attached implicitly by the +compiler. JSON diff --git a/tools/nimweb.nim b/tools/nimweb.nim index e74b081ea..61cae5170 100644 --- a/tools/nimweb.nim +++ b/tools/nimweb.nim @@ -303,14 +303,10 @@ proc mexec(cmds: openarray[string], processors: int) = proc buildDocSamples(c: var TConfigData, destPath: string) = ## Special case documentation sample proc. ## - ## The docgen sample needs to be generated twice with different commands, so - ## it didn't make much sense to integrate into the existing generic - ## documentation builders. - const src = "doc"/"docgen_sample.nim" + ## TODO: consider integrating into the existing generic documentation builders + ## now that we have a single `doc` command. exec(findNim(c) & " doc $# -o:$# $#" % - [c.nimArgs, destPath / "docgen_sample.html", src]) - exec(findNim(c) & " doc2 $# -o:$# $#" % - [c.nimArgs, destPath / "docgen_sample2.html", src]) + [c.nimArgs, destPath / "docgen_sample.html", "doc" / "docgen_sample.nim"]) proc pathPart(d: string): string = splitFile(d).dir.replace('\\', '/') |