Skip to content

Commit 308f53d

Browse files
committed
Update instructions for building docs locally
1 parent 63a5d21 commit 308f53d

File tree

1 file changed

+4
-12
lines changed

1 file changed

+4
-12
lines changed

CONTRIBUTING.md

Lines changed: 4 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -60,18 +60,10 @@ repository:
6060
repository.
6161
* Install [giza](https://pypi.python.org/pypi/giza/), as noted in the tools
6262
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 `giza make html`. You can suppress informational
74-
log messages via the `--level warning` option.
63+
* Sync your working copy of the documentation to the `source/` directory with
64+
`rsync -a --delete /path/to/mongo-php-library/docs/ source/`.
65+
* Build the documentation with `giza make publish`. You can suppress
66+
informational log messages with the `--level warning` option.
7567
* Generated documentation may be found in the `build/master/html` directory.
7668

7769
## Releasing

0 commit comments

Comments
 (0)