docs: remove most stale links; refs #9109
This commit is contained in:
parent
c404163bbf
commit
4f8cf945fb
7 changed files with 27 additions and 61 deletions
|
|
@ -131,7 +131,7 @@ Output::
|
|||
|
||||
Similarly to the old ``doc`` command the old ``jsondoc`` command has been
|
||||
renamed ``jsondoc0``.
|
||||
|
||||
|
||||
The ``jsondoc0`` command::
|
||||
nim jsondoc0 sample
|
||||
|
||||
|
|
@ -158,11 +158,11 @@ Project switch
|
|||
--------------
|
||||
|
||||
::
|
||||
nim doc2 --project filename.nim
|
||||
nim doc --project filename.nim
|
||||
|
||||
This will recursively generate documentation of all nim modules imported
|
||||
into the input module, including system modules. Be careful with this command,
|
||||
as it may end up sprinkling html files all over your filesystem!
|
||||
into the input module that belong to the Nimble package that ``filename.nim``
|
||||
belongs to.
|
||||
|
||||
|
||||
Index switch
|
||||
|
|
@ -222,9 +222,8 @@ Usage::
|
|||
Output::
|
||||
You're reading it!
|
||||
|
||||
The input can be viewed here `docgen.txt <docgen.txt>`_. The ``rst2tex``
|
||||
command is invoked identically to ``rst2html``, but outputs a .tex file instead
|
||||
of .html.
|
||||
The ``rst2tex`` command is invoked identically to ``rst2html``, but outputs
|
||||
a .tex file instead of .html.
|
||||
|
||||
|
||||
HTML anchor generation
|
||||
|
|
@ -312,8 +311,7 @@ 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. \`^\` like in `the actors module
|
||||
<actors.html#^,ptr.TChannel[T]>`_).
|
||||
Nim's rules (eg. \`^\`).
|
||||
2. Base filename plus anchor hyper link (eg.
|
||||
``algorithm.html#*,int,SortOrder``).
|
||||
3. Optional human readable string to display as hyper link. If the value is not
|
||||
|
|
|
|||
|
|
@ -27,10 +27,6 @@ The documentation consists of several documents:
|
|||
| The Nim compiler supports source code filters as a simple yet powerful
|
||||
builtin templating system.
|
||||
|
||||
- | `Term rewriting macros <trmacros.html>`_
|
||||
| Term rewriting macros enhance the compilation process with user defined
|
||||
optimizations.
|
||||
|
||||
- | `Internal documentation <intern.html>`_
|
||||
| The internal documentation describes how the compiler is implemented. Read
|
||||
this if you want to hack the compiler.
|
||||
|
|
|
|||
18
doc/lib.rst
18
doc/lib.rst
|
|
@ -184,12 +184,6 @@ Generic Operating System Services
|
|||
This module provides support for memory mapped files (Posix's ``mmap``)
|
||||
on the different operating systems.
|
||||
|
||||
* `fsmonitor <fsmonitor.html>`_
|
||||
This module implements the ability to monitor a directory/file for changes
|
||||
using Posix's inotify API.
|
||||
|
||||
**Warning:** This module will likely be moved out to a Nimble package soon.
|
||||
|
||||
* `asyncfile <asyncfile.html>`_
|
||||
This module implements asynchronous file reading and writing using
|
||||
``asyncdispatch``.
|
||||
|
|
@ -238,9 +232,6 @@ Internet Protocols and Support
|
|||
This module implements procs for opening URLs with the user's default
|
||||
browser.
|
||||
|
||||
* `httpserver <httpserver.html>`_
|
||||
This module implements a simple HTTP server.
|
||||
|
||||
* `httpclient <httpclient.html>`_
|
||||
This module implements a simple HTTP client which supports both synchronous
|
||||
and asynchronous retrieval of web pages.
|
||||
|
|
@ -289,11 +280,6 @@ Parsers
|
|||
* `parseopt <parseopt.html>`_
|
||||
The ``parseopt`` module implements a command line option parser.
|
||||
|
||||
* `parseopt2 <parseopt2.html>`_
|
||||
The ``parseopt2`` module implements a command line option parser. This
|
||||
supports long and short command options with optional values and command line
|
||||
arguments.
|
||||
|
||||
* `parsecfg <parsecfg.html>`_
|
||||
The ``parsecfg`` module implements a high performance configuration file
|
||||
parser. The configuration file's syntax is similar to the Windows ``.ini``
|
||||
|
|
@ -393,10 +379,6 @@ Multimedia support
|
|||
Miscellaneous
|
||||
-------------
|
||||
|
||||
* `events <events.html>`_
|
||||
This module implements an event system that is not dependent on external
|
||||
graphical toolkits.
|
||||
|
||||
* `oids <oids.html>`_
|
||||
An OID is a global ID that consists of a timestamp,
|
||||
a unique counter and a random value. This combination should suffice to
|
||||
|
|
|
|||
22
doc/nimc.rst
22
doc/nimc.rst
|
|
@ -136,7 +136,7 @@ source code with the `when statement <manual.html#when-statement>`_ and
|
|||
`defined proc <system.html#defined>`_. The typical use of this switch is to
|
||||
enable builds in release mode (``-d:release``) where certain safety checks are
|
||||
omitted for better performance. Another common use is the ``-d:ssl`` switch to
|
||||
activate `SSL sockets <sockets.html>`_.
|
||||
activate SSL sockets.
|
||||
|
||||
Additionally, you may pass a value along with the symbol: ``-d:x=y``
|
||||
which may be used in conjunction with the `compile time define
|
||||
|
|
@ -289,8 +289,7 @@ For example, with the above mentioned config::
|
|||
|
||||
This will generate a file called ``switchhomebrew.elf`` which can then be turned into
|
||||
an nro file with the ``elf2nro`` tool in the DevkitPro release. Examples can be found at
|
||||
`the nim-libnx github repo <https://github.com/jyapayne/nim-libnx.git>`_ or you can use
|
||||
`the switch builder tool <https://github.com/jyapayne/switch-builder.git>`_.
|
||||
`the nim-libnx github repo <https://github.com/jyapayne/nim-libnx.git>`_.
|
||||
|
||||
There are a few things that don't work because the DevkitPro libraries don't support them.
|
||||
They are:
|
||||
|
|
@ -396,11 +395,6 @@ the generated C contains code to ensure that proper stack traces with line
|
|||
number information are given if the program crashes or an uncaught exception
|
||||
is raised.
|
||||
|
||||
Debugger option
|
||||
---------------
|
||||
The ``debugger`` option enables or disables the *Embedded Nim Debugger*.
|
||||
See the documentation of endb_ for further information.
|
||||
|
||||
Hot code reloading
|
||||
------------------
|
||||
**Note:** At the moment hot code reloading is supported only in
|
||||
|
|
@ -442,11 +436,6 @@ Once your code is compiled for hot reloading, you can use a framework such
|
|||
as `LiveReload <http://livereload.com/>` or `BrowserSync <https://browsersync.io/>`
|
||||
to implement the actual reloading behavior in your project.
|
||||
|
||||
Breakpoint pragma
|
||||
-----------------
|
||||
The *breakpoint* pragma was specially added for the sake of debugging with
|
||||
ENDB. See the documentation of `endb <endb.html>`_ for further information.
|
||||
|
||||
|
||||
DynlibOverride
|
||||
==============
|
||||
|
|
@ -543,13 +532,6 @@ fatal errors that produce a stack trace. This can be disabled with the
|
|||
``-d:noSignalHandler`` switch.
|
||||
|
||||
|
||||
Debugging with Nim
|
||||
==================
|
||||
|
||||
Nim comes with its own *Embedded Nim Debugger*. See
|
||||
the documentation of endb_ for further information.
|
||||
|
||||
|
||||
Optimizing for Nim
|
||||
==================
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue