Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docgen: move to shared RST state (fix #16990) #18256

Merged
merged 14 commits into from
Jun 20, 2021
Merged

docgen: move to shared RST state (fix #16990) #18256

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
9408713
docgen: move to shared RST state (fix #16990)
a-mr Jun 5, 2021
336740f
Update lib/packages/docutils/rst.nim
a-mr Jun 14, 2021
a7aeb17
Update lib/packages/docutils/rst.nim
a-mr Jun 14, 2021
1ea5e9a
Update lib/packages/docutils/rst.nim
a-mr Jun 14, 2021
0d4d2af
Update compiler/docgen.nim
a-mr Jun 14, 2021
4542619
Update compiler/docgen.nim
a-mr Jun 14, 2021
0b5f5c8
Update compiler/docgen.nim
a-mr Jun 14, 2021
6830bf5
Update lib/packages/docutils/rst.nim
a-mr Jun 14, 2021
efc1004
rename `cmdDoc2` to `cmdDoc`
a-mr Jun 14, 2021
8bd2a10
fix (P)RstSharedState convention
a-mr Jun 14, 2021
60b0449
new style of initialization
a-mr Jun 14, 2021
9ba02dd
misc suggestions
a-mr Jun 14, 2021
95ba637
1 more rename
a-mr Jun 14, 2021
6a120a8
fix a regression
a-mr Jun 14, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion compiler/commands.nim
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -443,7 +443,7 @@ proc parseCommand*(command: string): Command =
of "check": cmdCheck
of "e": cmdNimscript
of "doc0": cmdDoc0
of "doc2", "doc": cmdDoc2
of "doc2", "doc": cmdDoc
of "doc2tex": cmdDoc2tex
of "rst2html": cmdRst2html
of "rst2tex": cmdRst2tex
Expand Down
243 changes: 160 additions & 83 deletions compiler/docgen.nim
View file
Open in desktop

Large diffs are not rendered by default.

1 change: 1 addition & 0 deletions compiler/docgen2.nim
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@ template closeImpl(body: untyped) {.dirty.} =
let useWarning = sfMainModule notin g.module.flags
let groupedToc = true
if shouldProcess(g):
finishGenerateDoc(g.doc)
body
try:
generateIndex(g.doc)
Expand Down
2 changes: 1 addition & 1 deletion compiler/main.nim
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -281,7 +281,7 @@ proc mainCommand*(graph: ModuleGraph) =
else:
rawMessage(conf, errGenerated, "'run' command not available; rebuild with -d:tinyc")
of cmdDoc0: docLikeCmd commandDoc(cache, conf)
of cmdDoc2:
of cmdDoc:
docLikeCmd():
conf.setNoteDefaults(warnLockLevel, false) # issue #13218
conf.setNoteDefaults(warnRedefinitionOfLabel, false) # issue #13218
Expand Down
6 changes: 3 additions & 3 deletions compiler/options.nim
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -143,8 +143,8 @@ type
cmdIdeTools # ide tools (e.g. nimsuggest)
cmdNimscript # evaluate nimscript
cmdDoc0
cmdDoc2
cmdDoc2tex
cmdDoc # convert .nim doc comments to HTML
cmdDoc2tex # convert .nim doc comments to LaTeX
cmdRst2html # convert a reStructuredText file to HTML
cmdRst2tex # convert a reStructuredText file to TeX
cmdJsondoc0
Expand All @@ -161,7 +161,7 @@ type

const
cmdBackends* = {cmdCompileToC, cmdCompileToCpp, cmdCompileToOC, cmdCompileToJS, cmdCrun}
cmdDocLike* = {cmdDoc0, cmdDoc2, cmdDoc2tex, cmdJsondoc0, cmdJsondoc,
cmdDocLike* = {cmdDoc0, cmdDoc, cmdDoc2tex, cmdJsondoc0, cmdJsondoc,
cmdCtags, cmdBuildindex}

type
Expand Down
Loading