diff options
| author | BinHong Lee <binhonglee@users.noreply.github.com> | 2019-12-14 00:40:53 -0800 |
|---|---|---|
| committer | Dominik Picheta <dominikpicheta@googlemail.com> | 2019-12-15 12:45:57 +0000 |
| commit | 20a59da401dc9252707bfe57edbec8f08a7a0973 (patch) | |
| tree | 9691f6cf598124474c90dff1cfcae6736ff2fc61 /doc/docgen.rst | |
| parent | 347a04606bddbb49f05e86188d96889617ce5136 (diff) | |
| download | Nim-20a59da401dc9252707bfe57edbec8f08a7a0973.tar.gz | |
Add `--git.devel` option to the documentation
Diffstat (limited to 'doc/docgen.rst')
| -rw-r--r-- | doc/docgen.rst | 4 |
1 files changed, 4 insertions, 0 deletions
diff --git a/doc/docgen.rst b/doc/docgen.rst index 4c05702ea..e7e5e71cc 100644 --- a/doc/docgen.rst +++ b/doc/docgen.rst @@ -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 |