aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorMarcin Szamotulski <coot@coot.me>2022-05-25 16:22:13 +0200
committerGitHub <noreply@github.com>2022-05-25 16:22:13 +0200
commit4367a8ef514fe0781cbea745a0b72871080d28fc (patch)
treeaef5f039268e4108e8ae413338dfa8b89a1f88a1 /doc
parent041385bc43f0b99d26077787eb8ed9e394766438 (diff)
Version bump 2.26.1 (#1489)
* Version bump 2.26.1 We extended format accepted by `--read-interface` option, which requires updating the minor version. * Update documentation of --read-interface option
Diffstat (limited to 'doc')
-rw-r--r--doc/invoking.rst4
1 files changed, 4 insertions, 0 deletions
diff --git a/doc/invoking.rst b/doc/invoking.rst
index 68e01d70..4b7f987c 100644
--- a/doc/invoking.rst
+++ b/doc/invoking.rst
@@ -58,6 +58,7 @@ The following options are available:
--read-interface=<docpath>,<file>
-i <docpath>,<srcpath>,<file>
--read-interface=<docpath>,<srcpath>,<file>
+ -i <docpath>,<srcpath>,<visibility>,<file>
Read the interface file in file, which must have been produced by
running Haddock with the :option:`--dump-interface` option. The interface
@@ -77,6 +78,9 @@ The following options are available:
hyperlinks but within sources rendered with :option:`--hyperlinked-source`
option.
+ If visibility is set to `hidden`, modules from that interface file will
+ not be listed in haddock generated content file.
+
Multiple :option:`--read-interface` options may be given.
.. option:: -D <file>