From 980b68d7a1643a20c82e364bf773639013c9930f Mon Sep 17 00:00:00 2001 From: Kyle Banker Date: Wed, 3 Nov 2010 12:40:58 -0400 Subject: [PATCH] minor: reorganized yardocs. starting to move tutorial and other docs to this repo. --- Rakefile | 2 +- 1.0_UPGRADE => docs/1.0_UPGRADE.md | 4 ++-- {docs => yard}/templates/default/tags/html/core.erb | 0 {docs => yard}/templates/default/tags/setup.rb | 0 {docs => yard}/yard_ext.rb | 0 5 files changed, 3 insertions(+), 3 deletions(-) rename 1.0_UPGRADE => docs/1.0_UPGRADE.md (85%) rename {docs => yard}/templates/default/tags/html/core.erb (100%) rename {docs => yard}/templates/default/tags/setup.rb (100%) rename {docs => yard}/yard_ext.rb (100%) diff --git a/Rakefile b/Rakefile index fe8c246..43094b9 100644 --- a/Rakefile +++ b/Rakefile @@ -169,7 +169,7 @@ task :ydoc do require File.join(File.dirname(__FILE__), 'lib', 'mongo') out = File.join('ydoc', Mongo::VERSION) FileUtils.rm_rf('ydoc') - system "yardoc lib/**/*.rb lib/mongo/**/*.rb lib/bson/**/*.rb -e docs/yard_ext.rb -p docs/templates -o #{out} --title MongoRuby-#{Mongo::VERSION}" + system "yardoc lib/**/*.rb lib/mongo/**/*.rb lib/bson/**/*.rb -e yard/yard_ext.rb -p yard/templates -o #{out} --title MongoRuby-#{Mongo::VERSION} --files docs/TUTORIAL.md,docs/1.0_UPGRADE.md" end namespace :gem do diff --git a/1.0_UPGRADE b/docs/1.0_UPGRADE.md similarity index 85% rename from 1.0_UPGRADE rename to docs/1.0_UPGRADE.md index 34635d4..86e294d 100644 --- a/1.0_UPGRADE +++ b/docs/1.0_UPGRADE.md @@ -17,5 +17,5 @@ collections, you should drop the current index and replace with a unique one. Be make sure that index doesn't exist; no need to go through process unnecessarily. If you do need to create the index, once you have the chunks collection, here are the commands you can run: -@chunks.drop_index('files_id_1_n_1') -@chunks.create_index([['files_id', Mongo::ASCENDING], ['n', Mongo::ASCENDING]], :unique => true) + @chunks.drop_index('files_id_1_n_1') + @chunks.create_index([['files_id', Mongo::ASCENDING], ['n', Mongo::ASCENDING]], :unique => true) diff --git a/docs/templates/default/tags/html/core.erb b/yard/templates/default/tags/html/core.erb similarity index 100% rename from docs/templates/default/tags/html/core.erb rename to yard/templates/default/tags/html/core.erb diff --git a/docs/templates/default/tags/setup.rb b/yard/templates/default/tags/setup.rb similarity index 100% rename from docs/templates/default/tags/setup.rb rename to yard/templates/default/tags/setup.rb diff --git a/docs/yard_ext.rb b/yard/yard_ext.rb similarity index 100% rename from docs/yard_ext.rb rename to yard/yard_ext.rb