Skip to content

Commit

Permalink
fixes #8215; remove reference to old doc command which was deprecated (
Browse files Browse the repository at this point in the history
  • Loading branch information
timotheecour authored and Araq committed Aug 5, 2018
1 parent c57e320 commit baa7738
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 25 deletions.
21 changes: 3 additions & 18 deletions doc/docgen.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
10 changes: 3 additions & 7 deletions tools/nimweb.nim
Original file line number Diff line number Diff line change
Expand Up @@ -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('\\', '/')

Expand Down

0 comments on commit baa7738

Please sign in to comment.