document proper imports, fixes #8164 (#10698)

This commit is contained in:
Miran 2019-02-19 12:49:09 +01:00 • committed by GitHub
commit 8cf97908cc
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
6 changed files with 16 additions and 6 deletions

View file

@ -336,23 +336,23 @@ Parsers
This is a low level module that implements an extremely efficient buffering This is a low level module that implements an extremely efficient buffering
scheme for lexers and parsers. This is used by the diverse parsing modules. scheme for lexers and parsers. This is used by the diverse parsing modules.
* `highlite <highlite.html>`_ * `packages/docutils/highlite <highlite.html>`_
Source highlighter for programming or markup languages. Currently Source highlighter for programming or markup languages. Currently
only few languages are supported, other languages may be added. only few languages are supported, other languages may be added.
The interface supports one language nested in another. The interface supports one language nested in another.
* `rst <rst.html>`_ * `packages/docutils/rst <rst.html>`_
This module implements a reStructuredText parser. A large subset This module implements a reStructuredText parser. A large subset
is implemented. Some features of the markdown wiki syntax are is implemented. Some features of the markdown wiki syntax are
also supported. also supported.
* `rstast <rstast.html>`_ * `packages/docutils/rstast <rstast.html>`_
This module implements an AST for the reStructuredText parser. This module implements an AST for the reStructuredText parser.
* `rstgen <rstgen.html>`_ * `packages/docutils/rstgen <rstgen.html>`_
This module implements a generator of HTML/Latex from reStructuredText. This module implements a generator of HTML/Latex from reStructuredText.
* `sexp <sexp.html>`_ * `packages/docutils/sexp <sexp.html>`_
High performance sexp parser and generator, mainly for communication High performance sexp parser and generator, mainly for communication
with emacs. with emacs.
@ -388,7 +388,7 @@ Cryptography and Hashing
* `base64 <base64.html>`_ * `base64 <base64.html>`_
This module implements a base64 encoder and decoder. This module implements a base64 encoder and decoder.
* `sha1 <sha1.html>`_ * `std/sha1 <sha1.html>`_
This module implements a sha1 encoder and decoder. This module implements a sha1 encoder and decoder.

View file

@ -10,6 +10,8 @@
## Source highlighter for programming or markup languages. ## Source highlighter for programming or markup languages.
## Currently only few languages are supported, other languages may be added. ## Currently only few languages are supported, other languages may be added.
## The interface supports one language nested in another. ## The interface supports one language nested in another.
##
## **Note:** Import ``packages/docutils/highlite`` to use this module
import import
strutils strutils

View file

@ -10,6 +10,8 @@
## This module implements a `reStructuredText`:idx: parser. A large ## This module implements a `reStructuredText`:idx: parser. A large
## subset is implemented. Some features of the `markdown`:idx: wiki syntax are ## subset is implemented. Some features of the `markdown`:idx: wiki syntax are
## also supported. ## also supported.
##
## **Note:** Import ``packages/docutils/rst`` to use this module
import import
os, strutils, rstast os, strutils, rstast

View file

@ -8,6 +8,8 @@
# #
## This module implements an AST for the `reStructuredText`:idx: parser. ## This module implements an AST for the `reStructuredText`:idx: parser.
##
## **Note:** Import ``packages/docutils/rstast`` to use this module
import strutils, json import strutils, json

View file

@ -22,6 +22,8 @@
## other lower level methods to finally build complete documents. This requires ## other lower level methods to finally build complete documents. This requires
## many options and tweaking, but you are not limited to snippets and can ## many options and tweaking, but you are not limited to snippets and can
## generate `LaTeX documents <https://en.wikipedia.org/wiki/LaTeX>`_ too. ## generate `LaTeX documents <https://en.wikipedia.org/wiki/LaTeX>`_ too.
##
## **Note:** Import ``packages/docutils/rstgen`` to use this module
import strutils, os, hashes, strtabs, rstast, rst, highlite, tables, sequtils, import strutils, os, hashes, strtabs, rstast, rst, highlite, tables, sequtils,
algorithm, parseutils algorithm, parseutils

View file

@ -7,6 +7,8 @@
# distribution, for details about the copyright. # distribution, for details about the copyright.
# #
## **Note:** Import ``nimsuggest/sexp`` to use this module
import import
hashes, strutils, lexbase, streams, unicode, macros hashes, strutils, lexbase, streams, unicode, macros