diff --git a/snooty.toml b/snooty.toml index b9bbb429..f2840471 100644 --- a/snooty.toml +++ b/snooty.toml @@ -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" diff --git a/source/aggregation.txt b/source/aggregation.txt index 55fc3a16..a30317f2 100644 --- a/source/aggregation.txt +++ b/source/aggregation.txt @@ -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>`__ \ No newline at end of file +- `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>`__ \ No newline at end of file diff --git a/source/api.txt b/source/api.txt new file mode 100644 index 00000000..eb027514 --- /dev/null +++ b/source/api.txt @@ -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+}> diff --git a/source/configuration/sharding.txt b/source/configuration/sharding.txt index 52d77a28..95c259a0 100644 --- a/source/configuration/sharding.txt +++ b/source/configuration/sharding.txt @@ -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. diff --git a/source/data-modeling/documents.txt b/source/data-modeling/documents.txt index 5fcbea93..97442968 100644 --- a/source/data-modeling/documents.txt +++ b/source/data-modeling/documents.txt @@ -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 ------------------- diff --git a/source/data-modeling/indexes.txt b/source/data-modeling/indexes.txt index 6e8dcbd6..736e0141 100644 --- a/source/data-modeling/indexes.txt +++ b/source/data-modeling/indexes.txt @@ -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. \ No newline at end of file diff --git a/source/data-modeling/persistence-configuration.txt b/source/data-modeling/persistence-configuration.txt index b281b5d5..83a9f032 100644 --- a/source/data-modeling/persistence-configuration.txt +++ b/source/data-modeling/persistence-configuration.txt @@ -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>`__ \ No newline at end of file +- `#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>`__ \ No newline at end of file diff --git a/source/img/rails-blog-new-comment.png b/source/img/rails-blog-new-comment.png deleted file mode 100644 index f82a56e9..00000000 Binary files a/source/img/rails-blog-new-comment.png and /dev/null differ diff --git a/source/img/rails-new-blog.png b/source/img/rails-new-blog.png deleted file mode 100644 index 210355a2..00000000 Binary files a/source/img/rails-new-blog.png and /dev/null differ diff --git a/source/index.txt b/source/index.txt index 4077ab12..5ec4d9ba 100644 --- a/source/index.txt +++ b/source/index.txt @@ -19,7 +19,7 @@ MongoDB in Ruby. To work with {+odm+} from the command line using Model Your Data Configuration /working-with-data - API + API Documentation /whats-new Issues & Help /additional-resources