From 6ede98d578af77169a17957df26883c1f30ac97e Mon Sep 17 00:00:00 2001 From: Timothee Cour Date: Sun, 19 Apr 2020 16:21:17 -0700 Subject: [PATCH] add nimlinks.md with useful links --- compiler/docgen.nim | 5 +++-- config/nimdoc.cfg | 8 +++++++- nimlinks.md | 23 +++++++++++++++++++++++ 3 files changed, 33 insertions(+), 3 deletions(-) create mode 100644 nimlinks.md diff --git a/compiler/docgen.nim b/compiler/docgen.nim index a42be9a9cffb6..59e05c7916e19 100644 --- a/compiler/docgen.nim +++ b/compiler/docgen.nim @@ -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"), [ diff --git a/config/nimdoc.cfg b/config/nimdoc.cfg index 4faebdf7218e7..18ebb747392d9 100644 --- a/config/nimdoc.cfg +++ b/config/nimdoc.cfg @@ -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 @@ -102,6 +102,9 @@ doc.body_toc = """
  • Index
    • +
  • + Links +
    • @@ -145,6 +148,9 @@ doc.body_toc_group = """
  • Index
    • +
  • + Links +
    • diff --git a/nimlinks.md b/nimlinks.md new file mode 100644 index 0000000000000..d1aa7925484eb --- /dev/null +++ b/nimlinks.md @@ -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)