diff options
author | Andrey Makarov <ph.makarov@gmail.com> | 2021-06-04 17:16:51 +0300 |
---|---|---|
committer | GitHub <noreply@github.com> | 2021-06-04 16:16:51 +0200 |
commit | 7e21218a07f919d56cd0974c657aefb11574da26 (patch) | |
tree | 615e4f371046e14d02d1d045ac081e80d37c3ca5 /doc/tools.rst | |
parent | 654a20166eabb614cbf0379c67115981f0532079 (diff) | |
download | Nim-7e21218a07f919d56cd0974c657aefb11574da26.tar.gz |
follow-up #18013 - inline syntax highlighting (#18166)
Diffstat (limited to 'doc/tools.rst')
-rw-r--r-- | doc/tools.rst | 15 |
1 files changed, 8 insertions, 7 deletions
diff --git a/doc/tools.rst b/doc/tools.rst index e0044e1ca..0de4ac914 100644 --- a/doc/tools.rst +++ b/doc/tools.rst @@ -1,9 +1,10 @@ -.. default-role:: code - ======================== Tools available with Nim ======================== +.. default-role:: code +.. include:: rstcommon.rst + The standard distribution ships with the following tools: - | `Hot code reloading <hcr.html>`_ @@ -11,11 +12,11 @@ The standard distribution ships with the following tools: document explaining how it works. - | `Documentation generator <docgen.html>`_ - | The builtin document generator `nim doc` generates HTML documentation - from `.nim` source files. + | The builtin document generator `nim doc`:cmd: generates HTML documentation + from ``.nim`` source files. - | `Nimsuggest for IDE support <nimsuggest.html>`_ - | Through the `nimsuggest` tool, any IDE can query a `.nim` source file + | Through the `nimsuggest`:cmd: tool, any IDE can query a ``.nim`` source file and obtain useful information like the definition of symbols or suggestions for completion. @@ -29,11 +30,11 @@ The standard distribution ships with the following tools: | Nim search and replace utility. - | nimpretty - | `nimpretty` is a Nim source code beautifier, + | `nimpretty`:cmd: is a Nim source code beautifier, to format code according to the official style guide. - | `testament <https://nim-lang.github.io/Nim/testament.html>`_ - | `testament` is an advanced automatic *unittests runner* for Nim tests, + | `testament`:cmd: is an advanced automatic *unittests runner* for Nim tests, is used for the development of Nim itself, offers process isolation for your tests, it can generate statistics about test cases, supports multiple targets (C, JS, etc), `simulated Dry-Runs <https://en.wikipedia.org/wiki/Dry_run_(testing)>`_, |