Skip to content

Commit cdc2060

Browse files
committed
Merge pull request #273
2 parents 2665bc3 + 4c683f0 commit cdc2060

File tree

1 file changed

+30
-0
lines changed

1 file changed

+30
-0
lines changed

CONTRIBUTING.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,36 @@ By default, the PHPUnit script relies on the `php` interpreter for your shell
4444
$ hhvm vendor/bin/phpunit
4545
```
4646

47+
## Documentation
48+
49+
Documentation for the library lives in the `docs/` directory and is built with
50+
tools in the related
51+
[mongodb/docs-php-library](https://github.com/mongodb/docs-php-library)
52+
repository. The tools repository is already configured to reference our sources.
53+
54+
That said, any changes to the documentation should be tested locally before
55+
committing. Follow the following steps to build the docs locally with the tools
56+
repository:
57+
58+
* Clone the
59+
[mongodb/docs-php-library](https://github.com/mongodb/docs-php-library) tools
60+
repository.
61+
* Install [giza](https://pypi.python.org/pypi/giza/), as noted in the tools
62+
README.
63+
* Comment out the following `assets` entry in `config/build_conf.yaml`:
64+
```
65+
- branch: master
66+
path: build/php-library # this is where we'll put the source docs (from the driver repo)
67+
repository: https://github.com/mongodb/mongo-php-library.git
68+
```
69+
70+
* Create a symlink so that `build/php-library` points to your working copy of
71+
the [mongodb/mongo-php-library](https://github.com/mongodb/mongo-php-library)
72+
repository.
73+
* Build the documentation with `gize make html`. You can suppress informational
74+
log messages via the `--level warning` option.
75+
* Generated documentation may be found in the `build/master/html` directory.
76+
4777
## Releasing
4878

4979
The follow steps outline the release process for a maintenance branch (e.g.

0 commit comments

Comments
 (0)