Document base-url option

haskell · Mar 10, 2021 · 478f005 · 478f005
1 parent 465c0af
commit 478f005
Showing 1 changed file with 7 additions and 0 deletions.
diff --git 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>