Add Github Actions workflow to build documentation (#993)

* Add workflow to build and check docs

* Fix docs build warnings

Author: alcaeus

.github/workflows/docs.yml

@@ -0,0 +1,56 @@
+name: "Docs"
+
+on:
+  pull_request:
+    branches:
+      - "v*.*"
+      - "master"
+      - "feature/*"
+  push:
+    branches:
+      - "v*.*"
+      - "master"
+      - "feature/*"
+
+jobs:
+  giza:
+    name: "Build Docs"
+    runs-on: "ubuntu-20.04"
+
+    steps:
+      - name: "Checkout library"
+        uses: "actions/checkout@v3"
+        with:
+          path: library
+          fetch-depth: 2
+
+      - name: "Checkout docs"
+        uses: "actions/checkout@v3"
+        with:
+          repository: mongodb/docs-php-library
+          path: docs
+          fetch-depth: 2
+
+      - name: "Setup python"
+        uses: actions/setup-python@v4
+        with:
+          python-version: '2.7'
+
+      # The requirements file installs urllib3 with an incompatible version; we replace it with one that works
+      - name: "Install giza"
+        run: |
+          pip install -r https://raw.githubusercontent.com/mongodb/docs-tools/master/giza/requirements.txt
+          pip install urllib3==1.25.2 
+
+      - name: "Sync documentation"
+        run: "rsync -a library/docs/ docs/source/"
+
+      - name: "Run Giza"
+        run: "giza make publish"
+        working-directory: docs
+
+      - name: "Upload built documentation"
+        uses: actions/upload-artifact@v3
+        with:
+          name: php-library-docs.tar.gz
+          path: docs/build/public/master/php-library.tar.gz

docs/reference/bson.txt

@@ -14,8 +14,8 @@ Overview
 --------
 
 MongoDB stores data records as BSON documents. BSON is a binary representation
-of :term:`JSON` documents, though it contains more data types than JSON. For the
-BSON spec, see `bsonspec.org <https://bsonspec.org/>`_.
+of JSON documents, though it contains more data types than JSON. For the BSON
+spec, see `bsonspec.org <https://bsonspec.org/>`_.
 
 By default, the |php-library| returns BSON documents as
 :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.
    When deserializing a PHP variable from BSON, the encoded class name of a
    :php:`Persistable <mongodb-bson-persistable>` object will override any class
    specified in the type map, but it will not override ``"array"`` and
-   ``"stdClass"`` or ``"object"``. This is discussed in the 
+   ``"stdClass"`` or ``"object"``. This is discussed in the
    :php:`persistence specification <mongodb.persistence>` but it bears
    repeating.
 
@@ -121,7 +121,7 @@ Consider the following class definition:
        private $id;
        private $name;
        private $createdAt;
-       
+
        public function __construct($name)
        {
            $this->id = new MongoDB\BSON\ObjectId;

docs/reference/method/MongoDBChangeStream-current.txt

@@ -103,4 +103,4 @@ See Also
 - :ref:`Tailable Cursor Iteration <php-tailable-cursor>`
 - :manual:`Change Streams </changeStreams>` documentation in the MongoDB manual
 - :manual:`Change Events </reference/change-events/>` documentation in the
-  MongoDB manual
+  MongoDB manual

docs/reference/method/MongoDBChangeStream-key.txt

@@ -73,4 +73,4 @@ See Also
 - :phpmethod:`MongoDB\\Database::watch()`
 - :php:`Iterator::key() <iterator.key>`
 - :ref:`Tailable Cursor Iteration <php-tailable-cursor>`
-- :manual:`Change Streams </changeStreams>` documentation in the MongoDB manual
+- :manual:`Change Streams </changeStreams>` documentation in the MongoDB manual