Skip to content
Snippets Groups Projects
Unverified Commit d8e55bd9 authored by Oleg Grenrus's avatar Oleg Grenrus Committed by GitHub
Browse files

Merge pull request #6199 from toonn/doc-html-location

Improve docs for html-location
parents 773ad13a cffeb597
No related branches found
No related tags found
No related merge requests found
...@@ -1829,6 +1829,7 @@ running ``setup haddock``. (TODO: Where does the documentation get put.) ...@@ -1829,6 +1829,7 @@ running ``setup haddock``. (TODO: Where does the documentation get put.)
``haddock`` command). ``haddock`` command).
.. cfg-field:: haddock-html-location: templated path .. cfg-field:: haddock-html-location: templated path
--html-location=TEMPLATE
:synopsis: Haddock HTML templates location. :synopsis: Haddock HTML templates location.
Specify a template for the location of HTML documentation for Specify a template for the location of HTML documentation for
...@@ -1839,15 +1840,19 @@ running ``setup haddock``. (TODO: Where does the documentation get put.) ...@@ -1839,15 +1840,19 @@ running ``setup haddock``. (TODO: Where does the documentation get put.)
:: ::
html-location: 'http://hackage.haskell.org/packages/archive/$pkg/latest/doc/html' html-location: http://hackage.haskell.org/packages/archive/$pkg/latest/doc/html
The command line variant of this flag is ``--html-location`` (for
the ``haddock`` subcommand).
::
--html-location='http://hackage.haskell.org/packages/archive/$pkg/latest/doc/html'
Here the argument is quoted to prevent substitution by the shell. If Here the argument is quoted to prevent substitution by the shell. If
this option is omitted, the location for each package is obtained this option is omitted, the location for each package is obtained
using the package tool (e.g. ``ghc-pkg``). using the package tool (e.g. ``ghc-pkg``).
The command line variant of this flag is ``--html-location`` (for
the ``haddock`` subcommand).
.. cfg-field:: haddock-executables: boolean .. cfg-field:: haddock-executables: boolean
:synopsis: Generate documentation for executables. :synopsis: Generate documentation for executables.
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment