Skip to content

Commit

Permalink
fixes nim-lang#9462; jsondoc --index can generate a theindex.json (ni…
Browse files Browse the repository at this point in the history
  • Loading branch information
ringabout authored and capocasa committed Mar 31, 2023
1 parent c6c38d9 commit 0f9a473
Show file tree
Hide file tree
Showing 3 changed files with 29 additions and 10 deletions.
16 changes: 16 additions & 0 deletions compiler/docgen.nim
Original file line number Diff line number Diff line change
Expand Up @@ -1124,6 +1124,8 @@ proc genJsonItem(d: PDoc, n, nameNode: PNode, k: TSymKind): JsonItem =
for kind in genericParam.sym.typ.sons:
param["types"].add %($kind)
result.json["signature"]["genericParams"].add param
if optGenIndex in d.conf.globalOptions:
genItem(d, n, nameNode, k, kForceExport)

proc setDoctype(d: PDoc, n: PNode) =
## Processes `{.doctype.}` pragma changing Markdown/RST parsing options.
Expand Down Expand Up @@ -1782,3 +1784,17 @@ proc commandBuildIndex*(conf: ConfigRef, dir: string, outFile = RelativeFile"")
writeFile(filename, code)
except:
rawMessage(conf, errCannotOpenFile, filename.string)

proc commandBuildIndexJson*(conf: ConfigRef, dir: string, outFile = RelativeFile"") =
var (modules, symbols, docs) = readIndexDir(dir)
let documents = toSeq(keys(Table[IndexEntry, seq[IndexEntry]](docs)))
let body = %*({"documents": documents, "modules": modules, "symbols": symbols})

var outFile = outFile
if outFile.isEmpty: outFile = theindexFname.RelativeFile.changeFileExt("")
let filename = getOutFile(conf, outFile, JsonExt)

try:
writeFile(filename, $body)
except:
rawMessage(conf, errCannotOpenFile, filename.string)
6 changes: 5 additions & 1 deletion compiler/main.nim
Original file line number Diff line number Diff line change
Expand Up @@ -325,7 +325,11 @@ proc mainCommand*(graph: ModuleGraph) =
else:
docLikeCmd commandDoc2(graph, TexExt)
of cmdJsondoc0: docLikeCmd commandJson(cache, conf)
of cmdJsondoc: docLikeCmd commandDoc2(graph, JsonExt)
of cmdJsondoc:
docLikeCmd():
commandDoc2(graph, JsonExt)
if optGenIndex in conf.globalOptions and optWholeProject in conf.globalOptions:
commandBuildIndexJson(conf, $conf.outDir)
of cmdCtags: docLikeCmd commandTags(cache, conf)
of cmdBuildindex: docLikeCmd commandBuildIndex(conf, $conf.projectFull, conf.outFile)
of cmdGendepend: commandGenDepend(graph)
Expand Down
17 changes: 8 additions & 9 deletions lib/packages/docutils/rstgen.nim
Original file line number Diff line number Diff line change
Expand Up @@ -417,13 +417,13 @@ proc renderIndexTerm*(d: PDoc, n: PRstNode, result: var string) =
[id, term])

type
IndexEntry = object
keyword: string
link: string
linkTitle: string ## contains a prettier text for the href
linkDesc: string ## the title attribute of the final href
IndexEntry* = object
keyword*: string
link*: string
linkTitle*: string ## contains a prettier text for the href
linkDesc*: string ## the title attribute of the final href

IndexedDocs = Table[IndexEntry, seq[IndexEntry]] ## \
IndexedDocs* = Table[IndexEntry, seq[IndexEntry]] ## \
## Contains the index sequences for doc types.
##
## The key is a *fake* IndexEntry which will contain the title of the
Expand Down Expand Up @@ -625,7 +625,7 @@ proc generateModuleJumps(modules: seq[string]): string =

result.add(chunks.join(", ") & ".<br/>")

proc readIndexDir(dir: string):
proc readIndexDir*(dir: string):
tuple[modules: seq[string], symbols: seq[IndexEntry], docs: IndexedDocs] =
## Walks `dir` reading ``.idx`` files converting them in IndexEntry items.
##
Expand Down Expand Up @@ -691,8 +691,6 @@ proc readIndexDir(dir: string):
title.linkTitle = "doc_toc_" & $result.docs.len
result.docs[title] = fileEntries

sort(result.modules, system.cmp)

proc mergeIndexes*(dir: string): string =
## Merges all index files in `dir` and returns the generated index as HTML.
##
Expand Down Expand Up @@ -722,6 +720,7 @@ proc mergeIndexes*(dir: string): string =
## Returns the merged and sorted indices into a single HTML block which can
## be further embedded into nimdoc templates.
var (modules, symbols, docs) = readIndexDir(dir)
sort(modules, system.cmp)

result = ""
# Generate a quick jump list of documents.
Expand Down

0 comments on commit 0f9a473

Please sign in to comment.