Skip to content

Commit 406ab0d

Browse files
committed
minor: CDRIVER-419 add instructions for how to generate docs
1 parent e57189e commit 406ab0d

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

README.rst

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -150,3 +150,15 @@ from Visual Studio as well::
150150
msbuild.exe ALL_BUILD.vcxproj
151151
msbuild.exe INSTALL.vcxproj
152152

153+
154+
Generating the Docs
155+
===================
156+
157+
To generate the documentation you must install the `yelp-tools` package.
158+
On Linux this package can be found in the package manager for your distribution,
159+
on OSX we recommend using [TingPing's homebrew-gnome tap](https://github.com/TingPing/homebrew-gnome).
160+
161+
Then use the following `./configure` options:
162+
163+
* `--enable-html-docs` - builds the HTML documentation
164+
* `--enable-man-pages` - builds and installs the man-pages.

0 commit comments

Comments
 (0)