diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/apis.md (renamed from doc/apis.rst) | 0 | ||||
| -rw-r--r-- | doc/backends.md (renamed from doc/backends.rst) | 3 | ||||
| -rw-r--r-- | doc/contributing.md (renamed from doc/contributing.rst) | 2 | ||||
| -rw-r--r-- | doc/destructors.md (renamed from doc/destructors.rst) | 0 | ||||
| -rw-r--r-- | doc/docgen.md (renamed from doc/docgen.rst) | 63 | ||||
| -rw-r--r-- | doc/docs.md (renamed from doc/docs.rst) | 0 | ||||
| -rw-r--r-- | doc/docstyle.md (renamed from doc/docstyle.rst) | 0 | ||||
| -rw-r--r-- | doc/drnim.md (renamed from doc/drnim.rst) | 0 | ||||
| -rw-r--r-- | doc/estp.md (renamed from doc/estp.rst) | 0 | ||||
| -rw-r--r-- | doc/filters.md (renamed from doc/filters.rst) | 0 | ||||
| -rw-r--r-- | doc/hcr.md (renamed from doc/hcr.rst) | 0 | ||||
| -rw-r--r-- | doc/idetools.md (renamed from doc/idetools.rst) | 0 | ||||
| -rw-r--r-- | doc/intern.md (renamed from doc/intern.rst) | 6 | ||||
| -rw-r--r-- | doc/koch.md (renamed from doc/koch.rst) | 0 | ||||
| -rw-r--r-- | doc/lib.md (renamed from doc/lib.rst) | 0 | ||||
| -rw-r--r-- | doc/manual.md (renamed from doc/manual.rst) | 8 | ||||
| -rw-r--r-- | doc/manual/var_t_return.md (renamed from doc/manual/var_t_return.rst) | 0 | ||||
| -rw-r--r-- | doc/manual_experimental.md (renamed from doc/manual_experimental.rst) | 2 | ||||
| -rw-r--r-- | doc/manual_experimental_strictnotnil.md (renamed from doc/manual_experimental_strictnotnil.rst) | 0 | ||||
| -rw-r--r-- | doc/mm.md (renamed from doc/mm.rst) | 2 | ||||
| -rw-r--r-- | doc/nep1.md (renamed from doc/nep1.rst) | 0 | ||||
| -rw-r--r-- | doc/nimc.md (renamed from doc/nimc.rst) | 6 | ||||
| -rw-r--r-- | doc/nimfix.md (renamed from doc/nimfix.rst) | 0 | ||||
| -rw-r--r-- | doc/nimgrep.md (renamed from doc/nimgrep.rst) | 2 | ||||
| -rw-r--r-- | doc/niminst.md (renamed from doc/niminst.rst) | 0 | ||||
| -rw-r--r-- | doc/nims.md (renamed from doc/nims.rst) | 0 | ||||
| -rw-r--r-- | doc/nimsuggest.md (renamed from doc/nimsuggest.rst) | 0 | ||||
| -rw-r--r-- | doc/overview.md (renamed from doc/overview.rst) | 2 | ||||
| -rw-r--r-- | doc/packaging.md (renamed from doc/packaging.rst) | 0 | ||||
| -rw-r--r-- | doc/refc.md (renamed from doc/refc.rst) | 0 | ||||
| -rw-r--r-- | doc/testament.md (renamed from doc/testament.rst) | 0 | ||||
| -rw-r--r-- | doc/tools.md (renamed from doc/tools.rst) | 0 | ||||
| -rw-r--r-- | doc/tut1.md (renamed from doc/tut1.rst) | 0 | ||||
| -rw-r--r-- | doc/tut2.md (renamed from doc/tut2.rst) | 2 | ||||
| -rw-r--r-- | doc/tut3.md (renamed from doc/tut3.rst) | 2 |
35 files changed, 50 insertions, 50 deletions
diff --git a/doc/apis.rst b/doc/apis.md index f0b8c93e5..f0b8c93e5 100644 --- a/doc/apis.rst +++ b/doc/apis.md diff --git a/doc/backends.rst b/doc/backends.md index 65dd8a6f2..a135e78b0 100644 --- a/doc/backends.rst +++ b/doc/backends.md @@ -10,7 +10,8 @@ .. no syntax highlighting here by default: .. contents:: - "Heresy grows from idleness." -- Unknown. + +> "Heresy grows from idleness." -- Unknown. Introduction diff --git a/doc/contributing.rst b/doc/contributing.md index 0ca0d0cbc..51d1d5065 100644 --- a/doc/contributing.rst +++ b/doc/contributing.md @@ -581,7 +581,7 @@ Code reviews -.. include:: docstyle.rst +.. include:: docstyle.md Evolving the stdlib diff --git a/doc/destructors.rst b/doc/destructors.md index c98e94536..c98e94536 100644 --- a/doc/destructors.rst +++ b/doc/destructors.md diff --git a/doc/docgen.rst b/doc/docgen.md index 48166b2c5..5f5c4ecc0 100644 --- a/doc/docgen.rst +++ b/doc/docgen.md @@ -35,14 +35,13 @@ Quick start Generate HTML documentation for a file: -.. code:: cmd - + ```cmd nim doc <filename>.nim + ``` Generate HTML documentation for a whole project: -.. code:: cmd - + ```cmd # delete any htmldocs/*.idx file before starting nim doc --project --index:on --git.url:<url> --git.commit:<tag> --outdir:htmldocs <main_filename>.nim # this will generate html files, a theindex.html index, css and js under `htmldocs` @@ -54,7 +53,7 @@ Generate HTML documentation for a whole project: # or `$nimcache/htmldocs` with `--usenimcache` which avoids clobbering your sources; # and likewise without `--project`. # Adding `-r` will open in a browser directly. - + ``` Documentation Comments ---------------------- @@ -120,8 +119,8 @@ Example of Nim file input The following examples will generate documentation for this sample *Nim* module, aptly named ``doc/docgen_sample.nim``: -.. code:: nim - :file: docgen_sample.nim + ```nim file=docgen_sample.nim + ``` All the below commands save their output to ``htmldocs`` directory relative to the directory of file; @@ -137,9 +136,9 @@ optionally, an index file. The `doc`:option: command: -.. code:: cmd - + ```cmd nim doc docgen_sample.nim + ``` Partial Output:: ... @@ -159,8 +158,7 @@ HTML -> PDF conversion). The `doc2tex`:option: command: -.. code:: cmd - + ```cmd nim doc2tex docgen_sample.nim cd htmldocs xelatex docgen_sample.tex @@ -169,6 +167,7 @@ The `doc2tex`:option: command: # large documents) to get all labels generated. # That depends on this warning in the end of `xelatex` output: # LaTeX Warning: Label(s) may have changed. Rerun to get cross-references right. + ``` The output is ``docgen_sample.pdf``. @@ -183,9 +182,9 @@ Note that this tool is built off of the `doc`:option: command The `jsondoc`:option: command: -.. code:: cmd - + ```cmd nim jsondoc docgen_sample.nim + ``` Output:: { @@ -209,9 +208,9 @@ renamed to `jsondoc0`:option:. The `jsondoc0`:option: command: -.. code:: cmd - + ```cmd nim jsondoc0 docgen_sample.nim + ``` Output:: [ @@ -249,9 +248,9 @@ the anchor [*]_ of Nim symbol that corresponds to link text. If you have a constant: -.. code:: Nim - + ```Nim const pi* = 3.14 + ``` then it should be referenced in one of the 2 forms: @@ -262,9 +261,9 @@ B. qualified (with symbol kind specification):: For routine kinds there are more options. Consider this definition: -.. code:: Nim - + ```Nim proc foo*(a: int, b: float): string + ``` Generally following syntax is allowed for referencing `foo`: @@ -352,11 +351,11 @@ recognized fine:: (without parameter names, see form A.2 above). E.g. for this signature: - .. code:: Nim - + ```Nim proc binarySearch*[T, K](a: openArray[T]; key: K; cmp: proc (x: T; y: K): int {.closure.}): int ~~ ~~ ~~~~~ + ``` you cannot use names underlined by `~~` so it must be referenced with ``cmp: proc(T, K)``. Hence these forms are valid:: @@ -379,10 +378,10 @@ recognized fine:: .. Note:: A bit special case is operators (as their signature is also defined with `\``): - .. code:: Nim - + ```Nim func `$`(x: MyType): string func `[]`*[T](x: openArray[T]): T + ``` A short form works without additional backticks:: @@ -412,9 +411,9 @@ Related Options Project switch -------------- -.. code:: cmd - + ```cmd nim doc --project filename.nim + ``` This will recursively generate documentation of all Nim modules imported into the input module that belong to the Nimble package that ``filename.nim`` @@ -425,9 +424,9 @@ also be generated. Index switch ------------ -.. code:: cmd - + ```cmd nim doc --index:on filename.nim + ``` This will generate an index of all the exported symbols in the input Nim module, and put it into a neighboring file with the extension of ``.idx``. The @@ -443,9 +442,9 @@ file. See source switch ----------------- -.. code:: cmd - + ```cmd nim doc --git.url:<url> filename.nim + ``` With the `git.url`:option: switch the *See source* hyperlink will appear below each documented item in your source code pointing to the implementation of that @@ -490,9 +489,9 @@ supports highlighting of a few other languages supported by the Usage: -.. code:: cmd - + ```cmd nim rst2html docgen.rst + ``` Output:: You're reading it! @@ -528,7 +527,7 @@ HTML file, most browsers will go to the first one. To differentiate the rest, you will need to use the complex name. A complex name for a callable type is made up of several parts: - (**plain symbol**)(**.type**),(**first param**)?(**,param type**)\* + (**plain symbol**)(**.type**),(**first param**)?(**,param type**)\* The first thing to note is that all callable types have at least a comma, even if they don't have any parameters. If there are parameters, they are diff --git a/doc/docs.rst b/doc/docs.md index 3c348fcb8..3c348fcb8 100644 --- a/doc/docs.rst +++ b/doc/docs.md diff --git a/doc/docstyle.rst b/doc/docstyle.md index df1f36dad..df1f36dad 100644 --- a/doc/docstyle.rst +++ b/doc/docstyle.md diff --git a/doc/drnim.rst b/doc/drnim.md index 070cd1787..070cd1787 100644 --- a/doc/drnim.rst +++ b/doc/drnim.md diff --git a/doc/estp.rst b/doc/estp.md index 550194d2d..550194d2d 100644 --- a/doc/estp.rst +++ b/doc/estp.md diff --git a/doc/filters.rst b/doc/filters.md index e237744cb..e237744cb 100644 --- a/doc/filters.rst +++ b/doc/filters.md diff --git a/doc/hcr.rst b/doc/hcr.md index dd25e39b3..dd25e39b3 100644 --- a/doc/hcr.rst +++ b/doc/hcr.md diff --git a/doc/idetools.rst b/doc/idetools.md index dcafaf45f..dcafaf45f 100644 --- a/doc/idetools.rst +++ b/doc/idetools.md diff --git a/doc/intern.rst b/doc/intern.md index 9103c694c..0fd995582 100644 --- a/doc/intern.rst +++ b/doc/intern.md @@ -10,7 +10,7 @@ .. include:: rstcommon.rst .. contents:: - "Abstraction is layering ignorance on top of reality." -- Richard Gabriel +> "Abstraction is layering ignorance on top of reality." -- Richard Gabriel Directory structure @@ -276,8 +276,8 @@ and `exitingDebugSection()`:nim:. #. Compile the temp compiler with `--debugger:native -d:nimDebugUtils`:option: #. Set your desired breakpoints or watchpoints. #. Configure your debugger: - * GDB: execute `source tools/compiler.gdb` at startup - * LLDB execute `command source tools/compiler.lldb` at startup + * GDB: execute `source tools/compiler.gdb` at startup + * LLDB execute `command source tools/compiler.lldb` at startup #. Use one of the scoping helpers like so: .. code-block:: nim diff --git a/doc/koch.rst b/doc/koch.md index 91dd5d570..91dd5d570 100644 --- a/doc/koch.rst +++ b/doc/koch.md diff --git a/doc/lib.rst b/doc/lib.md index 2f3a315a8..2f3a315a8 100644 --- a/doc/lib.rst +++ b/doc/lib.md diff --git a/doc/manual.rst b/doc/manual.md index 571379a87..503b9538b 100644 --- a/doc/manual.rst +++ b/doc/manual.md @@ -10,9 +10,9 @@ Nim Manual .. contents:: - "Complexity" seems to be a lot like "energy": you can transfer it from the - end-user to one/some of the other players, but the total amount seems to remain - pretty much constant for a given task. -- Ran +> "Complexity" seems to be a lot like "energy": you can transfer it from the +> end-user to one/some of the other players, but the total amount seems to remain +> pretty much constant for a given task. -- Ran About this document @@ -4025,7 +4025,7 @@ In the standard library every name of a routine that returns a `var` type starts with the prefix `m` per convention. -.. include:: manual/var_t_return.rst +.. include:: manual/var_t_return.md Future directions ~~~~~~~~~~~~~~~~~ diff --git a/doc/manual/var_t_return.rst b/doc/manual/var_t_return.md index f5c5bc4c0..f5c5bc4c0 100644 --- a/doc/manual/var_t_return.rst +++ b/doc/manual/var_t_return.md diff --git a/doc/manual_experimental.rst b/doc/manual_experimental.md index 3089755cb..3968163c5 100644 --- a/doc/manual_experimental.rst +++ b/doc/manual_experimental.md @@ -505,7 +505,7 @@ The compiler ensures that every code path initializes variables which contain non-nilable pointers. The details of this analysis are still to be specified here. -.. include:: manual_experimental_strictnotnil.rst +.. include:: manual_experimental_strictnotnil.md Aliasing restrictions in parameter passing diff --git a/doc/manual_experimental_strictnotnil.rst b/doc/manual_experimental_strictnotnil.md index ebfca7e51..ebfca7e51 100644 --- a/doc/manual_experimental_strictnotnil.rst +++ b/doc/manual_experimental_strictnotnil.md diff --git a/doc/mm.rst b/doc/mm.md index b6941a901..09b235228 100644 --- a/doc/mm.rst +++ b/doc/mm.md @@ -11,7 +11,7 @@ Nim's Memory Management .. - "The road to hell is paved with good intentions." +> "The road to hell is paved with good intentions." Multi-paradigm Memory Management Strategies diff --git a/doc/nep1.rst b/doc/nep1.md index 9627071bf..9627071bf 100644 --- a/doc/nep1.rst +++ b/doc/nep1.md diff --git a/doc/nimc.rst b/doc/nimc.md index aa6650491..28a917d92 100644 --- a/doc/nimc.rst +++ b/doc/nimc.md @@ -11,9 +11,9 @@ .. - "Look at you, hacker. A pathetic creature of meat and bone, panting and - sweating as you run through my corridors. How can you challenge a perfect, - immortal machine?" +> "Look at you, hacker. A pathetic creature of meat and bone, panting and +> sweating as you run through my corridors. How can you challenge a perfect, +> immortal machine?" Introduction diff --git a/doc/nimfix.rst b/doc/nimfix.md index d105346da..d105346da 100644 --- a/doc/nimfix.rst +++ b/doc/nimfix.md diff --git a/doc/nimgrep.rst b/doc/nimgrep.md index 6088a4c45..ff2bf3a8d 100644 --- a/doc/nimgrep.rst +++ b/doc/nimgrep.md @@ -54,7 +54,7 @@ All examples below use default PCRE Regex patterns: nimgrep --excludeDir:'^\.git$' --excludeDir:'^\.hg$' --excludeDir:'^\.svn$' # short: --ed:'^\.git$' --ed:'^\.hg$' --ed:'^\.svn$' -+ To search only in paths containing the `tests` sub-directory recursively:: ++ To search only in paths containing the `tests` sub-directory recursively: .. code:: cmd nimgrep --recursive --includeDir:'(^|/)tests($|/)' diff --git a/doc/niminst.rst b/doc/niminst.md index 2da8664a9..2da8664a9 100644 --- a/doc/niminst.rst +++ b/doc/niminst.md diff --git a/doc/nims.rst b/doc/nims.md index 4141c3bdc..4141c3bdc 100644 --- a/doc/nims.rst +++ b/doc/nims.md diff --git a/doc/nimsuggest.rst b/doc/nimsuggest.md index 82693da0e..82693da0e 100644 --- a/doc/nimsuggest.rst +++ b/doc/nimsuggest.md diff --git a/doc/overview.rst b/doc/overview.md index e01520d7c..b21eb1e68 100644 --- a/doc/overview.rst +++ b/doc/overview.md @@ -5,5 +5,5 @@ Nim Documentation Overview :Author: Andreas Rumpf :Version: |nimversion| -.. include:: docs.rst +.. include:: docs.md diff --git a/doc/packaging.rst b/doc/packaging.md index 7976dfe92..7976dfe92 100644 --- a/doc/packaging.rst +++ b/doc/packaging.md diff --git a/doc/refc.rst b/doc/refc.md index 766097f23..766097f23 100644 --- a/doc/refc.rst +++ b/doc/refc.md diff --git a/doc/testament.rst b/doc/testament.md index 427a7ff71..427a7ff71 100644 --- a/doc/testament.rst +++ b/doc/testament.md diff --git a/doc/tools.rst b/doc/tools.md index 0de4ac914..0de4ac914 100644 --- a/doc/tools.rst +++ b/doc/tools.md diff --git a/doc/tut1.rst b/doc/tut1.md index 66a4c3274..66a4c3274 100644 --- a/doc/tut1.rst +++ b/doc/tut1.md diff --git a/doc/tut2.rst b/doc/tut2.md index 725f68dd5..d37d6a16a 100644 --- a/doc/tut2.rst +++ b/doc/tut2.md @@ -13,7 +13,7 @@ Nim Tutorial (Part II) Introduction ============ - "Repetition renders the ridiculous reasonable." -- Norman Wildberger +> "Repetition renders the ridiculous reasonable." -- Norman Wildberger This document is a tutorial for the advanced constructs of the *Nim* programming language. **Note that this document is somewhat obsolete as the** diff --git a/doc/tut3.rst b/doc/tut3.md index c2c956107..2fcfd4220 100644 --- a/doc/tut3.rst +++ b/doc/tut3.md @@ -13,7 +13,7 @@ Nim Tutorial (Part III) Introduction ============ - "With Great Power Comes Great Responsibility." -- Spider Man's Uncle +> "With Great Power Comes Great Responsibility." -- Spider Man's Uncle This document is a tutorial about Nim's macro system. A macro is a function that is executed at compile-time and transforms |