mirrors/Nim
1
0
Fork 0
mirror of https://github.com/nim-lang/Nim.git synced 2026-01-03 19:52:36 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add --git.devel option to the documentation

Browse Source
This commit is contained in:
BinHong Lee
2019-12-14 00:40:53 -08:00
committed by Dominik Picheta
parent 347a04606b
commit 20a59da401
1 changed files with 4 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
doc/docgen.rst
View File

@@ -217,6 +217,10 @@ or to a tag e.g. `--git.commit:1.2.3` or a commit.
Source URLs are generated as `href="${url}/tree/${commit}/${path}#L${line}"` by default and this compatible with GitHub but not with GitLab.
Similarly, ``git.devel`` switch overrides the hardcoded `devel` branch for the `Edit` link which is also useful if you have a different working branch than `devel` e.g. `--git.devel:master`.
Edit URLs are generated as `href="${url}/tree/${devel}/${path}#L${line}"` by default.
You can edit ``config/nimdoc.cfg`` and modify the ``doc.item.seesrc`` value with a hyperlink to your own code repository.
In the case of Nim's own documentation, the ``commit`` value is just a commit