Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 2 additions & 3 deletions snooty.toml
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,6 @@ quickstart-sinatra-app-name = "my-sinatra-app"
quickstart-rails-app-name = "my-rails-app"
feedback-widget-title = "Feedback"
server-manual = "Server manual"
api-root = "https://www.mongodb.com/docs/mongoid/master/api/Mongoid"
api = "https://www.mongodb.com/docs/mongoid/master/api"
ruby-api = "https://www.mongodb.com/docs/ruby-driver/current/api/Mongo"
api = "https://www.mongodb.com/docs/mongoid/current/api"
ruby-api = "https://www.mongodb.com/docs/ruby-driver/current/api"
active-record-docs = "https://guides.rubyonrails.org"
6 changes: 3 additions & 3 deletions source/aggregation.txt
Original file line number Diff line number Diff line change
Expand Up @@ -227,6 +227,6 @@ API Documentation
To learn more about any of the methods discussed in this
guide, see the following API documentation:

- `group() <{+api-root+}/Criteria/Queryable/Aggregable.html#group-instance_method>`__
- `project() <{+api-root+}/Criteria/Queryable/Aggregable.html#project-instance_method>`__
- `unwind() <{+api-root+}/Criteria/Queryable/Aggregable.html#unwind-instance_method>`__
- `group() <{+api+}/Mongoid/Criteria/Queryable/Aggregable.html#group-instance_method>`__
- `project() <{+api+}/Mongoid/Criteria/Queryable/Aggregable.html#project-instance_method>`__
- `unwind() <{+api+}/Mongoid/Criteria/Queryable/Aggregable.html#unwind-instance_method>`__
15 changes: 15 additions & 0 deletions source/api.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
.. _mongoid-api-landing:

=================
API Documentation
=================

.. meta::
:description: Read the API documentation for Mongoid and the Ruby Driver.

.. toctree::
:titlesonly:
:maxdepth: 1

{+odm+} <{+api+}>
Ruby Driver <{+ruby-api+}>
2 changes: 1 addition & 1 deletion source/configuration/sharding.txt
Original file line number Diff line number Diff line change
Expand Up @@ -165,5 +165,5 @@ API Documentation

To learn more about the ``shard_key`` macro discussed in this
guide, see the `shard_key
<{+api-root+}/Shardable/ClassMethods.html#shard_key-instance_method>`__ API
<{+api+}/Mongoid/Shardable/ClassMethods.html#shard_key-instance_method>`__ API
documentation.
2 changes: 1 addition & 1 deletion source/data-modeling/documents.txt
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ in a sample ``Person`` model class:
end

You can find more information about the ``Document`` module in the `API
documentation <{+api-root+}/Document.html>`__.
documentation <{+api+}/Mongoid/Document.html>`__.

Work with Documents
-------------------
Expand Down
6 changes: 3 additions & 3 deletions source/data-modeling/indexes.txt
Original file line number Diff line number Diff line change
Expand Up @@ -208,12 +208,12 @@ API Documentation
-----------------

To learn more about using indexes in {+odm+}, see the
`Mongoid::Indexable::ClassMethods <{+api-root+}/Indexable/ClassMethods.html>`__
`Mongoid::Indexable::ClassMethods <{+api+}/Mongoid/Indexable/ClassMethods.html>`__
documentation.

To learn more about index options, see the `Mongoid::Indexable::Validators::Options
<{+api-root+}/Indexable/Validators/Options.html>`__ documentation.
<{+api+}/Mongoid/Indexable/Validators/Options.html>`__ documentation.

To learn more about using Atlas Search indexes in {+odm+}, see the
`Mongoid::SearchIndexable::ClassMethods <{+api-root+}/SearchIndexable/ClassMethods.html>`__
`Mongoid::SearchIndexable::ClassMethods <{+api+}/Mongoid/SearchIndexable/ClassMethods.html>`__
documentation.
20 changes: 10 additions & 10 deletions source/data-modeling/persistence-configuration.txt
Original file line number Diff line number Diff line change
Expand Up @@ -281,13 +281,13 @@ API Documentation
For more information about the methods mentioned in this guide, see the following
API documentation:

- `#client_name <{+api-root+}/PersistenceContext.html#client_name-instance_method>`__
- `#database_name <{+api-root+}/Clients/Options/ClassMethods.html#database_name-instance_method>`__
- `#collection_name <{+api-root+}/Clients/Options/ClassMethods.html#collection_name-instance_method>`__
- `#store_in <{+api-root+}/Clients/StorageOptions/ClassMethods.html#store_in-instance_method>`__
- `Model.with <{+api-root+}/Clients/Options.html#with-instance_method>`__
- `Mongoid::PersistenceContext <{+api-root+}/PersistenceContext.html>`__
- `Mongoid.override_client <{+api-root+}/Config.html#override_client-instance_method>`__
- `Mongoid.override_database <{+api-root+}/Config.html#override_database-instance_method>`__
- `Model.mongo_client <{+api-root+}/Clients/Options/ClassMethods.html#mongo_client-instance_method>`__
- `Model.collection <{+api-root+}/Clients/Options/ClassMethods.html#collection-instance_method>`__
- `#client_name <{+api+}/Mongoid/PersistenceContext.html#client_name-instance_method>`__
- `#database_name <{+api+}/Mongoid/Clients/Options/ClassMethods.html#database_name-instance_method>`__
- `#collection_name <{+api+}/Mongoid/Clients/Options/ClassMethods.html#collection_name-instance_method>`__
- `#store_in <{+api+}/Mongoid/Clients/StorageOptions/ClassMethods.html#store_in-instance_method>`__
- `Model.with <{+api+}/Mongoid/Clients/Options.html#with-instance_method>`__
- `Mongoid::PersistenceContext <{+api+}/Mongoid/PersistenceContext.html>`__
- `Mongoid.override_client <{+api+}/Mongoid/Config.html#override_client-instance_method>`__
- `Mongoid.override_database <{+api+}/Mongoid/Config.html#override_database-instance_method>`__
- `Model.mongo_client <{+api+}/Mongoid/Clients/Options/ClassMethods.html#mongo_client-instance_method>`__
- `Model.collection <{+api+}/Mongoid/Clients/Options/ClassMethods.html#collection-instance_method>`__
Binary file removed source/img/rails-blog-new-comment.png
Binary file not shown.
Binary file removed source/img/rails-new-blog.png
Binary file not shown.
2 changes: 1 addition & 1 deletion source/index.txt
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ MongoDB in Ruby. To work with {+odm+} from the command line using
Model Your Data </data-modeling>
Configuration </configuration>
/working-with-data
API <https://mongodb.com/docs/mongoid/master/api/>
API Documentation </api>
/whats-new
Issues & Help </issues-and-help>
/additional-resources
Expand Down
Loading