close #6071, remove the mentions of deprecated docSeeSrcUrl (#15350)

This commit is contained in:
Miran
2020-09-17 19:55:18 +02:00
committed by GitHub
parent bc9967f05a
commit cbd78ec1f6
2 changed files with 4 additions and 7 deletions

View File

@@ -55,13 +55,13 @@ doc.item.toc = """
"""
# HTML rendered for doc.item's seeSrc variable. Note that this will render to
# the empty string if you don't pass anything through --docSeeSrcURL. Available
# the empty string if you don't pass anything through --git.url. Available
# substitutaion variables here are:
# * $commit: branch/commit to use in source link.
# * $devel: branch to use in edit link.
# * $path: relative path to the file being processed.
# * $line: line of the item in the original source file.
# * $url: whatever you did pass through the --docSeeSrcUrl switch (which also
# * $url: whatever you did pass through the --git.url switch (which also
# gets variables path/line replaced!)
doc.item.seesrc = """&nbsp;&nbsp;<a
href="${url}/tree/${commit}/${path}#L${line}"

View File

@@ -209,8 +209,6 @@ file.
See source switch
-----------------
The ``docSeeSrcUrl`` switch is deprecated. Use:
::
nim doc2 --git.url:<url> filename.nim
@@ -345,9 +343,8 @@ but can have up to four (additional columns are ignored). The content of these
columns is:
1. Mandatory term being indexed. Terms can include quoting according to
Nim's rules (eg. \`^\`).
2. Base filename plus anchor hyperlink (eg.
``algorithm.html#*,int,SortOrder``).
Nim's rules (e.g. \`^\`).
2. Base filename plus anchor hyperlink (e.g. ``algorithm.html#*,int,SortOrder``).
3. Optional human readable string to display as hyperlink. If the value is not
present or is the empty string, the hyperlink will be rendered
using the term. Prefix whitespace indicates that this entry is