diff options
| author | Marcin Szamotulski <profunctor@pm.me> | 2021-08-16 08:46:03 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-08-16 08:46:03 +0200 |
| commit | 1b63771dee5a7fac0696505d0b335908bd12835d (patch) | |
| tree | 6f50d00fdb9813d5c49c405cf3651e01f9932cdc /doc/invoking.rst | |
| parent | 32d280f30d73bb38769700be6ddaf26b9a69c77e (diff) | |
coot/multiple package (ghc-head) (#1419)
* FromJSON class
Aeson style FromJSON class with Parsec based json parser.
* doc-index.json file for multiple packages
When creating haddock summary page for multiple packages render
doc-index.json file using contents of all found 'doc-index.json' files.
* Render doc-index.json
When rendering html, render doc-index.json file independently of
maybe_index_url option. doc-index.json file is useful now even if
maybe_index_url is not `Nothing`.
* base url option
New `Flag_BaseURL` which configures from where static files are loaded
(--base-url). If given and not equal "." static files are not coppied,
as this indicates that they are not read from the the directory where
we'd copy them. The default value is ".".
Diffstat (limited to 'doc/invoking.rst')
| -rw-r--r-- | doc/invoking.rst | 7 |
1 files changed, 7 insertions, 0 deletions
diff --git a/doc/invoking.rst b/doc/invoking.rst index 4e4b8764..68e01d70 100644 --- a/doc/invoking.rst +++ b/doc/invoking.rst @@ -223,6 +223,13 @@ The following options are available: Reserved for future use (output documentation in DocBook XML format). +.. option:: --base-url=<url> + + Base url for static assets (eg. css, javascript, json files etc.). + When present, static assets are not copied. This option is useful + when creating documentation for multiple packages, it allows to have + a single copy of static assets served from the given url. + .. option:: --source-base=<url> --source-module=<url> --source-entity=<url> |