DOCSP-607: tabbed examples for Ruby

Signed-off-by: kay <kay.kim@10gen.com>
mongodb · May 8, 2017 · 74f5063 · 74f5063
1 parent 50b22f4
commit 74f5063
Show file tree

Hide file tree

Showing 66 changed files with 774 additions and 6 deletions.
diff --git a/Makefile b/Makefile
@@ -72,3 +72,4 @@ examples:
 	curl -SfL https://raw.githubusercontent.com/mongodb/mongo-php-library/master/tests/DocumentationExamplesTest.php -o ${DRIVERS_PATH}/DocumentationExamplesTest.php
 	curl -SfL https://raw.githubusercontent.com/mongodb/mongo-java-driver/master/driver/src/examples/documentation/DocumentationSamples.java -o ${DRIVERS_PATH}/DocumentationSamples.java
 	curl -SfL https://raw.githubusercontent.com/mongodb/node-mongodb-native/2.2/test/functional/examples_tests.js -o ${DRIVERS_PATH}/examples_tests.js
+	curl -SfL https://raw.githubusercontent.com/mongodb/mongo-ruby-driver/master/spec/mongo/shell_examples_spec.rb -o ${DRIVERS_PATH}/shell_examples_spec.rb
diff --git a/conf.py b/conf.py
@@ -83,7 +83,8 @@ def has(self, *args):
     'wtdocs': ('http://source.wiredtiger.com/mongodb-3.4%s', ''),
     'perl-api': ('https://metacpan.org/pod/MongoDB::%s', ''),
     'node-docs': ('http://mongodb.github.io/node-mongodb-native/2.2/%s', ''),
-    'node-api': ('http://mongodb.github.io/node-mongodb-native/2.2/api/%s', '')
+    'node-api': ('http://mongodb.github.io/node-mongodb-native/2.2/api/%s', ''),
+    'ruby-api': ('http://api.mongodb.com/ruby/current/Mongo/%s', '')
 }
 
 ## add `extlinks` for each published version.

diff --git a/source/includes/driver-example-delete-55.rst b/source/includes/driver-example-delete-55.rst
@@ -64,3 +64,12 @@
             :dedent: 4
             :start-after: Start Example 55
             :end-before: End Example 55
+
+     - id: ruby
+       content: |
+         .. class:: copyable-code
+         .. literalinclude:: /driver-examples/shell_examples_spec.rb
+            :language: ruby
+            :dedent: 6
+            :start-after: Start Example 55
+            :end-before: End Example 55
diff --git a/source/includes/driver-example-delete-56.rst b/source/includes/driver-example-delete-56.rst
@@ -52,3 +52,12 @@
             :dedent: 4
             :start-after: Start Example 56
             :end-before: End Example 56
+
+     - id: ruby
+       content: |
+         .. class:: copyable-code
+         .. literalinclude:: /driver-examples/shell_examples_spec.rb
+            :language: ruby
+            :dedent: 8
+            :start-after: Start Example 56
+            :end-before: End Example 56
diff --git a/source/includes/driver-example-delete-57.rst b/source/includes/driver-example-delete-57.rst
@@ -52,3 +52,12 @@
             :dedent: 4
             :start-after: Start Example 57
             :end-before: End Example 57
+
+     - id: ruby
+       content: |
+         .. class:: copyable-code
+         .. literalinclude:: /driver-examples/shell_examples_spec.rb
+            :language: ruby
+            :dedent: 8
+            :start-after: Start Example 57
+            :end-before: End Example 57
diff --git a/source/includes/driver-example-delete-58.rst b/source/includes/driver-example-delete-58.rst
@@ -52,3 +52,12 @@
             :dedent: 4
             :start-after: Start Example 58
             :end-before: End Example 58
+
+     - id: ruby
+       content: |
+         .. class:: copyable-code
+         .. literalinclude:: /driver-examples/shell_examples_spec.rb
+            :language: ruby
+            :dedent: 8
+            :start-after: Start Example 58
+            :end-before: End Example 58
diff --git a/source/includes/driver-example-delete-result.rst b/source/includes/driver-example-delete-result.rst
@@ -46,3 +46,12 @@
          :perl-api:`MongoDB::DeleteResult<DeleteResult>` whose
          ``deleted_count`` attribute contains the number of documents
          that matched the filter.
+
+     - id: ruby
+       content: |
+         Upon successful execution, the
+         :ruby-api:`delete_many()<Collection.html#delete_many>` method
+         returns an instance of
+         :ruby-api:`Mongo::Operation::Result<Operation/Result.html>`, whose
+         ``deleted_count`` attribute contains the number of documents
+         that matched the filter.
diff --git a/source/includes/driver-example-insert-1.rst b/source/includes/driver-example-insert-1.rst
@@ -60,3 +60,12 @@
             :dedent: 4
             :start-after: Start Example 1
             :end-before: End Example 1
+
+     - id: ruby
+       content: |
+         .. class:: copyable-code
+         .. literalinclude:: /driver-examples/shell_examples_spec.rb
+            :language: ruby
+            :dedent: 6
+            :start-after: Start Example 1
+            :end-before: End Example 1
diff --git a/source/includes/driver-example-insert-2.rst b/source/includes/driver-example-insert-2.rst
@@ -52,3 +52,12 @@
             :dedent: 4
             :start-after: Start Example 2
             :end-before: End Example 2
+
+     - id: ruby
+       content: |
+         .. class:: copyable-code
+         .. literalinclude:: /driver-examples/shell_examples_spec.rb
+            :language: ruby
+            :dedent: 8
+            :start-after: Start Example 2
+            :end-before: End Example 2
diff --git a/source/includes/driver-example-insert-3.rst b/source/includes/driver-example-insert-3.rst
@@ -62,3 +62,12 @@
             :dedent: 4
             :start-after: Start Example 3
             :end-before: End Example 3
+
+     - id: ruby
+       content: |
+         .. class:: copyable-code
+         .. literalinclude:: /driver-examples/shell_examples_spec.rb
+            :language: ruby
+            :dedent: 8
+            :start-after: Start Example 3
+            :end-before: End Example 3
diff --git a/source/includes/driver-example-query-10.rst b/source/includes/driver-example-query-10.rst
@@ -52,3 +52,12 @@
             :dedent: 4
             :start-after: Start Example 10
             :end-before: End Example 10
+
+     - id: ruby
+       content: |
+         .. class:: copyable-code
+         .. literalinclude:: /driver-examples/shell_examples_spec.rb
+            :language: ruby
+            :dedent: 8
+            :start-after: Start Example 10
+            :end-before: End Example 10
diff --git a/source/includes/driver-example-query-11.rst b/source/includes/driver-example-query-11.rst
@@ -52,3 +52,12 @@
             :dedent: 4
             :start-after: Start Example 11
             :end-before: End Example 11
+
+     - id: ruby
+       content: |
+         .. class:: copyable-code
+         .. literalinclude:: /driver-examples/shell_examples_spec.rb
+            :language: ruby
+            :dedent: 8
+            :start-after: Start Example 11
+            :end-before: End Example 11
diff --git a/source/includes/driver-example-query-12.rst b/source/includes/driver-example-query-12.rst
@@ -52,3 +52,12 @@
             :dedent: 4
             :start-after: Start Example 12
             :end-before: End Example 12
+
+     - id: ruby
+       content: |
+         .. class:: copyable-code
+         .. literalinclude:: /driver-examples/shell_examples_spec.rb
+            :language: ruby
+            :dedent: 8
+            :start-after: Start Example 12
+            :end-before: End Example 12
diff --git a/source/includes/driver-example-query-13.rst b/source/includes/driver-example-query-13.rst
@@ -56,3 +56,12 @@
             :dedent: 4
             :start-after: Start Example 13
             :end-before: End Example 13
+
+     - id: ruby
+       content: |
+         .. class:: copyable-code
+         .. literalinclude:: /driver-examples/shell_examples_spec.rb
+            :language: ruby
+            :dedent: 8
+            :start-after: Start Example 13
+            :end-before: End Example 13
diff --git a/source/includes/driver-example-query-14.rst b/source/includes/driver-example-query-14.rst
@@ -64,3 +64,12 @@
             :dedent: 4
             :start-after: Start Example 14
             :end-before: End Example 14
+
+     - id: ruby
+       content: |
+         .. class:: copyable-code
+         .. literalinclude:: /driver-examples/shell_examples_spec.rb
+            :language: ruby
+            :dedent: 6
+            :start-after: Start Example 14
+            :end-before: End Example 14
diff --git a/source/includes/driver-example-query-15.rst b/source/includes/driver-example-query-15.rst
@@ -52,3 +52,12 @@
             :dedent: 4
             :start-after: Start Example 15
             :end-before: End Example 15
+
+     - id: ruby
+       content: |
+         .. class:: copyable-code
+         .. literalinclude:: /driver-examples/shell_examples_spec.rb
+            :language: ruby
+            :dedent: 8
+            :start-after: Start Example 15
+            :end-before: End Example 15
diff --git a/source/includes/driver-example-query-16.rst b/source/includes/driver-example-query-16.rst
@@ -52,3 +52,12 @@
             :dedent: 4
             :start-after: Start Example 16
             :end-before: End Example 16
+
+     - id: ruby
+       content: |
+         .. class:: copyable-code
+         .. literalinclude:: /driver-examples/shell_examples_spec.rb
+            :language: ruby
+            :dedent: 8
+            :start-after: Start Example 16
+            :end-before: End Example 16
diff --git a/source/includes/driver-example-query-17.rst b/source/includes/driver-example-query-17.rst
@@ -52,3 +52,12 @@
             :dedent: 4
             :start-after: Start Example 17
             :end-before: End Example 17
+
+     - id: ruby
+       content: |
+         .. class:: copyable-code
+         .. literalinclude:: /driver-examples/shell_examples_spec.rb
+            :language: ruby
+            :dedent: 8
+            :start-after: Start Example 17
+            :end-before: End Example 17
diff --git a/source/includes/driver-example-query-18.rst b/source/includes/driver-example-query-18.rst
@@ -52,3 +52,12 @@
             :dedent: 4
             :start-after: Start Example 18
             :end-before: End Example 18
+
+     - id: ruby
+       content: |
+         .. class:: copyable-code
+         .. literalinclude:: /driver-examples/shell_examples_spec.rb
+            :language: ruby
+            :dedent: 8
+            :start-after: Start Example 18
+            :end-before: End Example 18
diff --git a/source/includes/driver-example-query-19.rst b/source/includes/driver-example-query-19.rst
@@ -52,3 +52,12 @@
             :dedent: 4
             :start-after: Start Example 19
             :end-before: End Example 19
+
+     - id: ruby
+       content: |
+         .. class:: copyable-code
+         .. literalinclude:: /driver-examples/shell_examples_spec.rb
+            :language: ruby
+            :dedent: 8
+            :start-after: Start Example 19
+            :end-before: End Example 19
diff --git a/source/includes/driver-example-query-20.rst b/source/includes/driver-example-query-20.rst
@@ -64,3 +64,12 @@
             :dedent: 4
             :start-after: Start Example 20
             :end-before: End Example 20
+
+     - id: ruby
+       content: |
+         .. class:: copyable-code
+         .. literalinclude:: /driver-examples/shell_examples_spec.rb
+            :language: ruby
+            :dedent: 6
+            :start-after: Start Example 20
+            :end-before: End Example 20
diff --git a/source/includes/driver-example-query-21.rst b/source/includes/driver-example-query-21.rst
@@ -52,3 +52,12 @@
             :dedent: 4
             :start-after: Start Example 21
             :end-before: End Example 21
+
+     - id: ruby
+       content: |
+         .. class:: copyable-code
+         .. literalinclude:: /driver-examples/shell_examples_spec.rb
+            :language: ruby
+            :dedent: 8
+            :start-after: Start Example 21
+            :end-before: End Example 21
diff --git a/source/includes/driver-example-query-22.rst b/source/includes/driver-example-query-22.rst
@@ -52,3 +52,12 @@
             :dedent: 4
             :start-after: Start Example 22
             :end-before: End Example 22
+
+     - id: ruby
+       content: |
+         .. class:: copyable-code
+         .. literalinclude:: /driver-examples/shell_examples_spec.rb
+            :language: ruby
+            :dedent: 8
+            :start-after: Start Example 22
+            :end-before: End Example 22
diff --git a/source/includes/driver-example-query-23.rst b/source/includes/driver-example-query-23.rst
@@ -52,3 +52,12 @@
             :dedent: 4
             :start-after: Start Example 23
             :end-before: End Example 23
+
+     - id: ruby
+       content: |
+         .. class:: copyable-code
+         .. literalinclude:: /driver-examples/shell_examples_spec.rb
+            :language: ruby
+            :dedent: 8
+            :start-after: Start Example 23
+            :end-before: End Example 23
diff --git a/source/includes/driver-example-query-24.rst b/source/includes/driver-example-query-24.rst
@@ -52,3 +52,12 @@
             :dedent: 4
             :start-after: Start Example 24
             :end-before: End Example 24
+
+     - id: ruby
+       content: |
+         .. class:: copyable-code
+         .. literalinclude:: /driver-examples/shell_examples_spec.rb
+            :language: ruby
+            :dedent: 8
+            :start-after: Start Example 24
+            :end-before: End Example 24
diff --git a/source/includes/driver-example-query-25.rst b/source/includes/driver-example-query-25.rst
@@ -52,3 +52,12 @@
             :dedent: 4
             :start-after: Start Example 25
             :end-before: End Example 25
+
+     - id: ruby
+       content: |
+         .. class:: copyable-code
+         .. literalinclude:: /driver-examples/shell_examples_spec.rb
+            :language: ruby
+            :dedent: 8
+            :start-after: Start Example 25
+            :end-before: End Example 25
diff --git a/source/includes/driver-example-query-26.rst b/source/includes/driver-example-query-26.rst
@@ -52,3 +52,12 @@
             :dedent: 4
             :start-after: Start Example 26
             :end-before: End Example 26
+
+     - id: ruby
+       content: |
+         .. class:: copyable-code
+         .. literalinclude:: /driver-examples/shell_examples_spec.rb
+            :language: ruby
+            :dedent: 8
+            :start-after: Start Example 26
+            :end-before: End Example 26
diff --git a/source/includes/driver-example-query-27.rst b/source/includes/driver-example-query-27.rst
@@ -52,3 +52,12 @@
             :dedent: 4
             :start-after: Start Example 27
             :end-before: End Example 27
+
+     - id: ruby
+       content: |
+         .. class:: copyable-code
+         .. literalinclude:: /driver-examples/shell_examples_spec.rb
+            :language: ruby
+            :dedent: 8
+            :start-after: Start Example 27
+            :end-before: End Example 27
diff --git a/source/includes/driver-example-query-28.rst b/source/includes/driver-example-query-28.rst
@@ -52,3 +52,12 @@
             :dedent: 4
             :start-after: Start Example 28
             :end-before: End Example 28
+
+     - id: ruby
+       content: |
+         .. class:: copyable-code
+         .. literalinclude:: /driver-examples/shell_examples_spec.rb
+            :language: ruby
+            :dedent: 8
+            :start-after: Start Example 28
+            :end-before: End Example 28
diff --git a/source/includes/driver-example-query-29.rst b/source/includes/driver-example-query-29.rst
@@ -64,3 +64,12 @@
             :dedent: 4
             :start-after: Start Example 29
             :end-before: End Example 29
+
+     - id: ruby
+       content: |
+         .. class:: copyable-code
+         .. literalinclude:: /driver-examples/shell_examples_spec.rb
+            :language: ruby
+            :dedent: 6
+            :start-after: Start Example 29
+            :end-before: End Example 29