File tree 4 files changed +62
-6
lines changed 4 files changed +62
-6
lines changed Original file line number Diff line number Diff line change
1
+ name : " Docs"
2
+
3
+ on :
4
+ pull_request :
5
+ branches :
6
+ - " v*.*"
7
+ - " master"
8
+ - " feature/*"
9
+ push :
10
+ branches :
11
+ - " v*.*"
12
+ - " master"
13
+ - " feature/*"
14
+
15
+ jobs :
16
+ giza :
17
+ name : " Build Docs"
18
+ runs-on : " ubuntu-20.04"
19
+
20
+ steps :
21
+ - name : " Checkout library"
22
+ uses : " actions/checkout@v3"
23
+ with :
24
+ path : library
25
+ fetch-depth : 2
26
+
27
+ - name : " Checkout docs"
28
+ uses : " actions/checkout@v3"
29
+ with :
30
+ repository : mongodb/docs-php-library
31
+ path : docs
32
+ fetch-depth : 2
33
+
34
+ - name : " Setup python"
35
+ uses : actions/setup-python@v4
36
+ with :
37
+ python-version : ' 2.7'
38
+
39
+ # The requirements file installs urllib3 with an incompatible version; we replace it with one that works
40
+ - name : " Install giza"
41
+ run : |
42
+ pip install -r https://raw.githubusercontent.com/mongodb/docs-tools/master/giza/requirements.txt
43
+ pip install urllib3==1.25.2
44
+
45
+ - name : " Sync documentation"
46
+ run : " rsync -a library/docs/ docs/source/"
47
+
48
+ - name : " Run Giza"
49
+ run : " giza make publish"
50
+ working-directory : docs
51
+
52
+ - name : " Upload built documentation"
53
+ uses : actions/upload-artifact@v3
54
+ with :
55
+ name : php-library-docs.tar.gz
56
+ path : docs/build/public/master/php-library.tar.gz
Original file line number Diff line number Diff line change @@ -14,8 +14,8 @@ Overview
14
14
--------
15
15
16
16
MongoDB stores data records as BSON documents. BSON is a binary representation
17
- of :term:` JSON` documents, though it contains more data types than JSON. For the
18
- BSON spec, see `bsonspec.org <https://bsonspec.org/>`_.
17
+ of JSON documents, though it contains more data types than JSON. For the BSON
18
+ spec, see `bsonspec.org <https://bsonspec.org/>`_.
19
19
20
20
By default, the |php-library| returns BSON documents as
21
21
:phpclass:`MongoDB\\Model\\BSONDocument` objects and BSON arrays as
@@ -106,7 +106,7 @@ of the PHP class in a special property within the BSON document.
106
106
When deserializing a PHP variable from BSON, the encoded class name of a
107
107
:php:`Persistable <mongodb-bson-persistable>` object will override any class
108
108
specified in the type map, but it will not override ``"array"`` and
109
- ``"stdClass"`` or ``"object"``. This is discussed in the
109
+ ``"stdClass"`` or ``"object"``. This is discussed in the
110
110
:php:`persistence specification <mongodb.persistence>` but it bears
111
111
repeating.
112
112
@@ -121,7 +121,7 @@ Consider the following class definition:
121
121
private $id;
122
122
private $name;
123
123
private $createdAt;
124
-
124
+
125
125
public function __construct($name)
126
126
{
127
127
$this->id = new MongoDB\BSON\ObjectId;
Original file line number Diff line number Diff line change @@ -103,4 +103,4 @@ See Also
103
103
- :ref:`Tailable Cursor Iteration <php-tailable-cursor>`
104
104
- :manual:`Change Streams </changeStreams>` documentation in the MongoDB manual
105
105
- :manual:`Change Events </reference/change-events/>` documentation in the
106
- MongoDB manual
106
+ MongoDB manual
Original file line number Diff line number Diff line change @@ -73,4 +73,4 @@ See Also
73
73
- :phpmethod:`MongoDB\\Database::watch()`
74
74
- :php:`Iterator::key() <iterator.key>`
75
75
- :ref:`Tailable Cursor Iteration <php-tailable-cursor>`
76
- - :manual:`Change Streams </changeStreams>` documentation in the MongoDB manual
76
+ - :manual:`Change Streams </changeStreams>` documentation in the MongoDB manual
You can’t perform that action at this time.
0 commit comments