mirror of
https://github.com/nim-lang/Nim.git
synced 2025-12-29 01:14:41 +00:00
ff8ab06720
* suppresses non-exported fields of types and adds command-line option to re-enable this if desired * corrected the doctest that produced a CI error * an embarrassingly bad error in reasoning * modified a nimdoc test to reflect updated behavior * needed another change to bring utils.html doctest in sync with update * add info * fix nimdoc * lint * render postfix * fixes a problem * fixes nimdoc * fix nimdoc --------- Co-authored-by: johnperry-math <john.perry@usm.edu> Co-authored-by: johnperry-math <devotus@yahoo.com>
88 lines
2.5 KiB
Nim
88 lines
2.5 KiB
Nim
#
|
|
#
|
|
# The Nim Compiler
|
|
# (c) Copyright 2012 Andreas Rumpf
|
|
#
|
|
# See the file "copying.txt", included in this
|
|
# distribution, for details about the copyright.
|
|
#
|
|
|
|
# This module implements a new documentation generator that runs after
|
|
# semantic checking.
|
|
|
|
import
|
|
options, ast, msgs, passes, docgen, lineinfos, pathutils, packages
|
|
|
|
from modulegraphs import ModuleGraph, PPassContext
|
|
|
|
type
|
|
TGen = object of PPassContext
|
|
doc: PDoc
|
|
module: PSym
|
|
config: ConfigRef
|
|
PGen = ref TGen
|
|
|
|
proc shouldProcess(g: PGen): bool =
|
|
(optWholeProject in g.doc.conf.globalOptions and g.doc.conf.belongsToProjectPackage(g.module)) or
|
|
sfMainModule in g.module.flags or g.config.projectMainIdx == g.module.info.fileIndex
|
|
|
|
template closeImpl(body: untyped) {.dirty.} =
|
|
var g = PGen(p)
|
|
let useWarning = sfMainModule notin g.module.flags
|
|
let groupedToc = true
|
|
if shouldProcess(g):
|
|
finishGenerateDoc(g.doc)
|
|
body
|
|
try:
|
|
generateIndex(g.doc)
|
|
except IOError:
|
|
discard
|
|
|
|
proc close(graph: ModuleGraph; p: PPassContext, n: PNode): PNode =
|
|
closeImpl:
|
|
writeOutput(g.doc, useWarning, groupedToc)
|
|
|
|
proc closeJson(graph: ModuleGraph; p: PPassContext, n: PNode): PNode =
|
|
closeImpl:
|
|
writeOutputJson(g.doc, useWarning)
|
|
|
|
proc processNode(c: PPassContext, n: PNode): PNode =
|
|
result = n
|
|
var g = PGen(c)
|
|
if shouldProcess(g):
|
|
generateDoc(g.doc, n, n, g.config)
|
|
|
|
proc processNodeJson(c: PPassContext, n: PNode): PNode =
|
|
result = n
|
|
var g = PGen(c)
|
|
if shouldProcess(g):
|
|
generateJson(g.doc, n, false)
|
|
|
|
template myOpenImpl(ext: untyped) {.dirty.} =
|
|
var g: PGen
|
|
new(g)
|
|
g.module = module
|
|
g.config = graph.config
|
|
var d = newDocumentor(AbsoluteFile toFullPath(graph.config, FileIndex module.position),
|
|
graph.cache, graph.config, ext, module, hasToc = true)
|
|
g.doc = d
|
|
result = g
|
|
|
|
proc myOpen(graph: ModuleGraph; module: PSym; idgen: IdGenerator): PPassContext =
|
|
myOpenImpl(HtmlExt)
|
|
|
|
proc myOpenTex(graph: ModuleGraph; module: PSym; idgen: IdGenerator): PPassContext =
|
|
myOpenImpl(TexExt)
|
|
|
|
proc myOpenJson(graph: ModuleGraph; module: PSym; idgen: IdGenerator): PPassContext =
|
|
myOpenImpl(JsonExt)
|
|
|
|
const docgen2Pass* = makePass(open = myOpen, process = processNode, close = close)
|
|
const docgen2TexPass* = makePass(open = myOpenTex, process = processNode,
|
|
close = close)
|
|
const docgen2JsonPass* = makePass(open = myOpenJson, process = processNodeJson,
|
|
close = closeJson)
|
|
|
|
proc finishDoc2Pass*(project: string) =
|
|
discard
|