jyapayne/Nim
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Generates quick jump list to modules.

Browse source
This commit is contained in:
Grzegorz Adam Hankiewicz 2014-04-21 12:22:18 +02:00
commit fdf4bf2cfd
1 changed files with 24 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

28
lib/packages/docutils/rstgen.nim
View file

@ -484,12 +484,24 @@ proc generateDocumentationJumps(docs: TIndexedDocs): string =
result.add(chunks.join(", ") & ".<br>") result.add(chunks.join(", ") & ".<br>")
proc generateModuleJumps(modules: seq[string]): string =
## Returns a plain list of hyperlinks to the list of modules.
result = "Modules: "
var chunks: seq[string] = @[]
for name in modules:
chunks.add("<a href=\"" & name & ".html\">" & name & "</a>")
result.add(chunks.join(", ") & ".<br>")
proc readIndexDir(dir: string): proc readIndexDir(dir: string):
tuple[symbols: seq[TIndexEntry], docs: TIndexedDocs] = tuple[modules: seq[string], symbols: seq[TIndexEntry], docs: TIndexedDocs] =
## Walks `dir` reading ``.idx`` files converting them in TIndexEntry items. ## Walks `dir` reading ``.idx`` files converting them in TIndexEntry items.
## ##
## Returns the list of free symbol entries and the separate documentation ## Returns the list of found module names, the list of free symbol entries
## indexes found. See the documentation of ``mergeIndexes`` for details. ## and the different documentation indexes. The list of modules is sorted.
## See the documentation of ``mergeIndexes`` for details.
result.modules = @[]
result.docs = initTable[TIndexEntry, seq[TIndexEntry]](32) result.docs = initTable[TIndexEntry, seq[TIndexEntry]](32)
newSeq(result.symbols, 15_000) newSeq(result.symbols, 15_000)
setLen(result.symbols, 0) setLen(result.symbols, 0)
@ -530,11 +542,14 @@ proc readIndexDir(dir: string):
for i in 0 .. <F: for i in 0 .. <F:
result.symbols[L] = fileEntries[i] result.symbols[L] = fileEntries[i]
inc L inc L
result.modules.add(path.splitFile.name)
else: else:
# Generate the symbolic anchor for index quickjumps. # Generate the symbolic anchor for index quickjumps.
title.linkTitle = "doc_toc_" & $result.docs.len title.linkTitle = "doc_toc_" & $result.docs.len
result.docs[title] = fileEntries result.docs[title] = fileEntries
sort(result.modules, system.cmp)
proc mergeIndexes*(dir: string): string = proc mergeIndexes*(dir: string): string =
## Merges all index files in `dir` and returns the generated index as HTML. ## Merges all index files in `dir` and returns the generated index as HTML.
## ##
@ -561,7 +576,7 @@ proc mergeIndexes*(dir: string): string =
## ##
## Returns the merged and sorted indices into a single HTML block which can ## Returns the merged and sorted indices into a single HTML block which can
## be further embedded into nimdoc templates. ## be further embedded into nimdoc templates.
var (symbols, docs) = readIndexDir(dir) var (modules, symbols, docs) = readIndexDir(dir)
assert(not symbols.isNil) assert(not symbols.isNil)
result = "" result = ""
@ -570,6 +585,11 @@ proc mergeIndexes*(dir: string): string =
result.add(generateDocumentationJumps(docs)) result.add(generateDocumentationJumps(docs))
result.add("<p />") result.add("<p />")
# Generate hyperlinks to all the linked modules.
if modules.len > 0:
result.add(generateModuleJumps(modules))
result.add("<p />")
# Generate the HTML block with API documents. # Generate the HTML block with API documents.
if docs.len > 0: if docs.len > 0:
result.add("<h2>Documentation files</h2>\n") result.add("<h2>Documentation files</h2>\n")