Skip to content

Commit

Permalink
add nimlinks.md with useful links
Browse files Browse the repository at this point in the history
  • Loading branch information
timotheecour committed May 8, 2020
1 parent 5fa7d37 commit 6ede98d
Show file tree
Hide file tree
Showing 3 changed files with 33 additions and 3 deletions.
5 changes: 3 additions & 2 deletions compiler/docgen.nim
Original file line number Diff line number Diff line change
Expand Up @@ -1118,10 +1118,11 @@ proc genOutFile(d: PDoc): Rope =
let bodyname = if d.hasToc and not d.isPureRst: "doc.body_toc_group"
elif d.hasToc: "doc.body_toc"
else: "doc.body_no_toc"
let gitUrl = getConfigVar(d.conf, "git.url")
content = ropeFormatNamedVars(d.conf, getConfigVar(d.conf, bodyname), ["title",
"tableofcontents", "moduledesc", "date", "time", "content", "deprecationMsg"],
"tableofcontents", "moduledesc", "date", "time", "content", "deprecationMsg", "url"],
[title.rope, toc, d.modDesc, rope(getDateStr()),
rope(getClockStr()), code, d.modDeprecationMsg])
rope(getClockStr()), code, d.modDeprecationMsg, rope gitUrl])
if optCompileOnly notin d.conf.globalOptions:
# XXX what is this hack doing here? 'optCompileOnly' means raw output!?
code = ropeFormatNamedVars(d.conf, getConfigVar(d.conf, "doc.file"), [
Expand Down
8 changes: 7 additions & 1 deletion config/nimdoc.cfg
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# This is the config file for the documentation generator.
# (c) 2016 Andreas Rumpf
# Feel free to edit the templates as you need. If you modify this file, it
# might be worth updating the hardcoded values in packages/docutils/rstgen.nim
# might be worth updating the hardcoded values in lib/packages/docutils/rstgen.nim

split.item.toc = "20"
# too long entries in the table of contents wrap around
Expand Down Expand Up @@ -102,6 +102,9 @@ doc.body_toc = """
<li>
<a href="theindex.html">Index</a>
</li>
<li>
<a href="https://github.com/nim-lang/Nim/nimlinks.md">Links</a>
</li>
</ul>
</div>
<div id="searchInputDiv">
Expand Down Expand Up @@ -145,6 +148,9 @@ doc.body_toc_group = """
<li>
<a href="theindex.html">Index</a>
</li>
<li>
<a href="https://github.com/nim-lang/Nim/nimlinks.md">Links</a>
</li>
</ul>
</div>
<div id="searchInputDiv">
Expand Down
23 changes: 23 additions & 0 deletions nimlinks.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# Nim Links

## CI badges
devel: [![Build Status](https://dev.azure.com/nim-lang/Nim/_apis/build/status/nim-lang.Nim?branchName=devel)](https://dev.azure.com/nim-lang/Nim/_build/latest?definitionId=1&branchName=devel)
1.0: [![Build Status](https://dev.azure.com/nim-lang/Nim/_apis/build/status/nim-lang.Nim?branchName=version-1-0)](https://dev.azure.com/nim-lang/Nim/_build/latest?definitionId=1&branchName=version-1-0)
1.2: [![Build Status](https://dev.azure.com/nim-lang/Nim/_apis/build/status/nim-lang.Nim?branchName=version-1-2)](https://dev.azure.com/nim-lang/Nim/_build/latest?definitionId=1&branchName=version-1-2)
freebsd: [![builds.sr.ht freebsd status](https://builds.sr.ht/~araq/nim/commits/freebsd.yml.svg)](https://builds.sr.ht/~araq/nim/commits/freebsd.yml?)
openbsd: [![builds.sr.ht openbsd status](https://builds.sr.ht/~araq/nim/commits/openbsd.yml.svg)](https://builds.sr.ht/~araq/nim/commits/openbsd.yml?)
packages: ![Packages CI](https://github.com/nim-lang/Nim/workflows/Packages%20CI/badge.svg)
ssl: ![](https://github.com/nim-lang/Nim/workflows/Nim%20SSL%20CI/badge.svg)
docs: ![](https://github.com/nim-lang/Nim/workflows/Nim%20Docs%20CI/badge.svg)

## CI badges
* [experimental features](manual_experimental.html)
* [contributing](contributing.html)
* https://github.com/nim-lang/Nim/tree/devel/changelogs
* [changelogs](https://github.com/nim-lang/Nim/tree/devel/changelogs)
* https://nim-lang.org/
* https://nim-lang.org/docs/manual.html
* https://nim-lang.github.io/Nim/manual.html
* https://github.com/nim-lang/Nim
* https://nimble.directory/
* [azure test failure report](https://dev.azure.com/nim-lang/Nim/_test/analytics?definitionId=1&contextType=build)

0 comments on commit 6ede98d

Please sign in to comment.