File tree Expand file tree Collapse file tree 1 file changed +30
-0
lines changed Expand file tree Collapse file tree 1 file changed +30
-0
lines changed Original file line number Diff line number Diff line change @@ -44,6 +44,36 @@ By default, the PHPUnit script relies on the `php` interpreter for your shell
44
44
$ hhvm vendor/bin/phpunit
45
45
```
46
46
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
+
47
77
## Releasing
48
78
49
79
The follow steps outline the release process for a maintenance branch (e.g.
You can’t perform that action at this time.
0 commit comments