on master help sign in
update developer doc generation
commitd0ef2ba1f7c20805a02635a8882b4f9545afcf2f authorHarendra Kumar <harendra.kumar@gmail.com> dateMon 29 Jul 2019, 04:04 (7 years ago) parentc8a98dd
1 file changed+9−4
CONTRIBUTING.md+9−4
CONTRIBUTING.md+9−4
@@ -131,10 +131,15 @@ their existing code to the new change.
131131
132132## Developer documentation
133133
134−Build haddock with the `--show-all` option to see the documentation for all
135−modules including the ones not exposed to users of the library.
136−For example,
137−`stack haddock --haddock-arguments "--show-all" --no-haddock-deps`.
134+To build haddock documentation for all modules, including the ones not exposed
135+to users of the library, use the following commands:
136+
137+```
138+$ cabal v2-haddock --haddock-internal
139+$ stack haddock --haddock-arguments "--show-all" --no-haddock-deps
140+```
141+
142+For design documentation see the `design` directory.
138143
139144## Coding
140145