mirror of
https://github.com/nim-lang/Nim.git
synced 2025-12-29 17:34:43 +00:00
2620da9bf9
* docgen: implement cross-document links Fully implements https://github.com/nim-lang/RFCs/issues/125 Follow-up of: https://github.com/nim-lang/Nim/pull/18642 (for internal links) and https://github.com/nim-lang/Nim/issues/20127. Overview -------- Explicit import-like directive is required, called `.. importdoc::`. (the syntax is % RST, Markdown will use it for a while). Then one can reference any symbols/headings/anchors, as if they were in the local file (but they will be prefixed with a module name or markup document in link text). It's possible to reference anything from anywhere (any direction in `.nim`/`.md`/`.rst` files). See `doc/docgen.md` for full description. Working is based on `.idx` files, hence one needs to generate all `.idx` beforehand. A dedicated option `--index:only` is introduced (and a separate stage for `--index:only` is added to `kochdocs.nim`). Performance note ---------------- Full run for `./koch docs` now takes 185% of the time before this PR. (After: 315 s, before: 170 s on my PC). All the time seems to be spent on `--index:only` run, which takes almost as much (85%) of normal doc run -- it seems that most time is spent on file parsing, turning off HTML generation phase has not helped much. (One could avoid it by specifying list of files that can be referenced and pre-processing only them. But it can become error-prone and I assume that these linke will be **everywhere** in the repository anyway, especially considering https://github.com/nim-lang/RFCs/issues/478. So every `.nim`/`.md` file is processed for `.idx` first). But that's all without significant part of repository converted to cross-module auto links. To estimate impact I checked the time for `doc`ing a few files (after all indexes have been generated), and everywhere difference was **negligible**. E.g. for `lib/std/private/osfiles.nim` that `importdoc`s large `os.idx` and hence should have been a case with relatively large performance impact, but: * After: 0.59 s. * Before: 0.59 s. So Nim compiler works so slow that doc part basically does not matter :-) Testing ------- 1) added `extlinks` test to `nimdoc/` 2) checked that `theindex.html` is still correct 2) fixed broken auto-links for modules that were derived from `os.nim` by adding appropriate ``importdoc`` Implementation note ------------------- Parsing and formating of `.idx` entries is moved into a dedicated `rstidx.nim` module from `rstgen.nim`. `.idx` file format changed: * fields are not escaped in most cases because we need original strings for referencing, not HTML ones (the exception is linkTitle for titles and headings). Escaping happens later -- on the stage of `rstgen` buildIndex, etc. * all lines have fixed number of columns 6 * added discriminator tag as a first column, it always allows distinguish Nim/markup entries, titles/headings, etc. `rstgen` does not rely any more (in most cases) on ad-hoc logic to determine what type each entry is. * there is now always a title entry added at the first line. * add a line number as 6th column * linkTitle (4th) column has a different format: before it was like `module: funcName()`, now it's `proc funcName()`. (This format is also propagated to `theindex.html` and search results, I kept it that way since I like it more though it's discussible.) This column is what used for Nim symbols resolution. * also changed details on column format for headings and titles: "keyword" is original, "linkTitle" is HTML one * fix paths on Windows + more clear code * Update compiler/docgen.nim Co-authored-by: Andreas Rumpf <rumpf_a@web.de> * Handle .md and .nim paths uniformly in findRefFile * handle titles better + more comments * don't allow markup overwrite index title for .nim files Co-authored-by: Andreas Rumpf <rumpf_a@web.de>
114 lines
4.1 KiB
Nim
114 lines
4.1 KiB
Nim
# Include file that implements 'DirSep' and friends. Do not import this when
|
|
# you also import `os.nim`!
|
|
|
|
# Improved based on info in 'compiler/platform.nim'
|
|
|
|
## .. importdoc:: ospaths2.nim
|
|
|
|
const
|
|
doslikeFileSystem* = defined(windows) or defined(OS2) or defined(DOS)
|
|
|
|
const
|
|
CurDir* =
|
|
when defined(macos): ':'
|
|
elif defined(genode): '/'
|
|
else: '.'
|
|
## The constant character used by the operating system to refer to the
|
|
## current directory.
|
|
##
|
|
## For example: `'.'` for POSIX or `':'` for the classic Macintosh.
|
|
|
|
ParDir* =
|
|
when defined(macos): "::"
|
|
else: ".."
|
|
## The constant string used by the operating system to refer to the
|
|
## parent directory.
|
|
##
|
|
## For example: `".."` for POSIX or `"::"` for the classic Macintosh.
|
|
|
|
DirSep* =
|
|
when defined(macos): ':'
|
|
elif doslikeFileSystem or defined(vxworks): '\\'
|
|
elif defined(RISCOS): '.'
|
|
else: '/'
|
|
## The character used by the operating system to separate pathname
|
|
## components, for example: `'/'` for POSIX, `':'` for the classic
|
|
## Macintosh, and `'\\'` on Windows.
|
|
|
|
AltSep* =
|
|
when doslikeFileSystem: '/'
|
|
else: DirSep
|
|
## An alternative character used by the operating system to separate
|
|
## pathname components, or the same as DirSep_ if only one separator
|
|
## character exists. This is set to `'/'` on Windows systems
|
|
## where DirSep_ is a backslash (`'\\'`).
|
|
|
|
PathSep* =
|
|
when defined(macos) or defined(RISCOS): ','
|
|
elif doslikeFileSystem or defined(vxworks): ';'
|
|
elif defined(PalmOS) or defined(MorphOS): ':' # platform has ':' but osseps has ';'
|
|
else: ':'
|
|
## The character conventionally used by the operating system to separate
|
|
## search path components (as in PATH), such as `':'` for POSIX
|
|
## or `';'` for Windows.
|
|
|
|
FileSystemCaseSensitive* =
|
|
when defined(macos) or defined(macosx) or doslikeFileSystem or defined(vxworks) or
|
|
defined(PalmOS) or defined(MorphOS): false
|
|
else: true
|
|
## True if the file system is case sensitive, false otherwise. Used by
|
|
## `cmpPaths proc`_ to compare filenames properly.
|
|
|
|
ExeExt* =
|
|
when doslikeFileSystem: "exe"
|
|
elif defined(atari): "tpp"
|
|
elif defined(netware): "nlm"
|
|
elif defined(vxworks): "vxe"
|
|
elif defined(nintendoswitch): "elf"
|
|
else: ""
|
|
## The file extension of native executables. For example:
|
|
## `""` for POSIX, `"exe"` on Windows (without a dot).
|
|
|
|
ScriptExt* =
|
|
when doslikeFileSystem: "bat"
|
|
else: ""
|
|
## The file extension of a script file. For example: `""` for POSIX,
|
|
## `"bat"` on Windows.
|
|
|
|
DynlibFormat* =
|
|
when defined(macos): "$1.dylib" # platform has $1Lib
|
|
elif defined(macosx): "lib$1.dylib"
|
|
elif doslikeFileSystem or defined(atari): "$1.dll"
|
|
elif defined(MorphOS): "$1.prc"
|
|
elif defined(PalmOS): "$1.prc" # platform has lib$1.so
|
|
elif defined(genode): "$1.lib.so"
|
|
elif defined(netware): "$1.nlm"
|
|
elif defined(amiga): "$1.Library"
|
|
else: "lib$1.so"
|
|
## The format string to turn a filename into a `DLL`:idx: file (also
|
|
## called `shared object`:idx: on some operating systems).
|
|
|
|
ExtSep* = '.'
|
|
## The character which separates the base filename from the extension;
|
|
## for example, the `'.'` in `os.nim`.
|
|
|
|
# MacOS paths
|
|
# ===========
|
|
# MacOS directory separator is a colon ":" which is the only character not
|
|
# allowed in filenames.
|
|
#
|
|
# A path containing no colon or which begins with a colon is a partial
|
|
# path.
|
|
# E.g. ":kalle:petter" ":kalle" "kalle"
|
|
#
|
|
# All other paths are full (absolute) paths. E.g. "HD:kalle:" "HD:"
|
|
# When generating paths, one is safe if one ensures that all partial paths
|
|
# begin with a colon, and all full paths end with a colon.
|
|
# In full paths the first name (e g HD above) is the name of a mounted
|
|
# volume.
|
|
# These names are not unique, because, for instance, two diskettes with the
|
|
# same names could be inserted. This means that paths on MacOS are not
|
|
# waterproof. In case of equal names the first volume found will do.
|
|
# Two colons "::" are the relative path to the parent. Three is to the
|
|
# grandparent etc.
|